Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding api overview #33

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

NiklasVousten
Copy link
Contributor

This adds a small info about the api in the README.md
Additionally it adds the openapi specification of the API.

See #32

@msrd0
Copy link
Collaborator

msrd0 commented Sep 23, 2024

I don't think it is a good idea to add the openapi spec to the root of this repo. It is an auto-generated file, and those usually don't get placed in git sources, and especially not without CI checks to ensure they remain up to date.

@NiklasVousten
Copy link
Contributor Author

But I think it would be good to have the API definition anywhere else then code or an own instance with docs enabled.
This was a simple attempt to add this.

Do you have any suggestions?

@msrd0
Copy link
Collaborator

msrd0 commented Sep 24, 2024

What I usually do is ask CI to put stuff like auto generated documentation (usually the html from rustdoc) into the gh-pages branch. We could do something similar here, have CI generate the json and maybe even run redoc over it to get some html and publish to pages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants