Page MenuHomeSealhub

OpenAPI docs support in Sealious
Open, NormalPublic2 Points

Description

https://httptoolkit.com/blog/introduction-to-openapi/

Add OpenAPI support to Sealious. Let's start by adding all the built-in endpoints. Best to find a declarative way to do this, so there's not too much code to add each time we introduce new endpoint - but it's not a must.

Discourse thread: https://forum.sealcode.org/t/openapi-swagger-support-in-sealious/1828

Details

Coded by
jenkins-user
Reviewed by
kuba-orlik
Action required from
kuba-orlik

Revisions and Commits

Event Timeline

kuba-orlik merged a task: Unknown Object (Maniphest Task).Jan 12 2024, 19:08
ziomek updated Coded by, added: ziomek.
ziomek moved this task from To do to Doing on the Kanban board.

open API configuration that works for regular koa project is not working in sealious-playgrund and I don't know if it would work for Sealious because I dont know how to check it.

ziomek removed ziomek as the assignee of this task.Mar 19 2024, 20:47
ziomek updated Coded by, removed: ziomek.
ziomek updated Action required from, removed: ziomek.
ziomek subscribed.
jenkins-user updated Coded by, added: ziomek.
jenkins-user updated Action required from, added: ziomek.
ziomek removed ziomek as the assignee of this task.Mar 19 2024, 20:47
ziomek moved this task from Doing to To do on the Kanban board.
ziomek updated Coded by, removed: ziomek.
ziomek updated Action required from, removed: ziomek.
kuba-orlik merged a task: Unknown Object (Maniphest Task).Dec 19 2024, 19:57

kinda changed scope, only added schemas for now (collection models), as that already seemed to be a fair amount of code

image.png (1×1 px, 160 KB)

krzysztof added a revision: Restricted Differential Revision.Tue, Jan 7, 23:26
jenkins-user moved this task from To do to Review on the Kanban board.
jenkins-user updated Action required from, added: FilipI.
jenkins-user added a subscriber: krzysztof.
jenkins-user moved this task from Review to Doing on the Kanban board.
jenkins-user updated Reviewed by, added: kuba-orlik.
jenkins-user updated Coded by, added: jenkins-user.
jenkins-user updated Action required from, added: jenkins-user; removed: FilipI.
jenkins-user moved this task from Doing to Review on the Kanban board.
jenkins-user updated Action required from, added: kuba-orlik; removed: jenkins-user.
jenkins-user subscribed.