mirror of
https://github.com/pocket-id/pocket-id.git
synced 2025-12-11 07:32:57 +03:00
🚀 Feature: Open API swagger file #123
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @userbradley on GitHub.
Feature description
I would like to see an Open API spec published for the API, as well as a swagger page for Users deployments.
Pitch
The reason I'd like to see this is because I'd like to build tools off the back of the API, and a common method of interacting with an API in development is via Swagger.
Perhaps the feature to enable and disable swagger on users deployments would be good.
Ideally as a first step, I'd like to see an open-api file for the API
(Perhaps this already exists and I cant find it?)
@userbradley commented on GitHub:
Cheers - I was having a look at that pipeline earlier. I think that's going to be my solution.
Would you consider publishing the file as a static asset in GitHub or on the site at all?
@kmendell commented on GitHub:
@userbradley The Open API file is generated into our Documentation so those API docs are built off of that file.
Otherwise you would have to build the file your self, see the workflow on how we do this.
9e527831f9/.github/workflows/cloudflare-pages.yml (L38)@userbradley commented on GitHub:
Sweeeeeet. Awesome thanks
@kmendell commented on GitHub:
@userbradley https://pocket-id.org/swagger.yaml, its generated to here. And thats updated anytime we deploy a new website build.