Open
Conversation
Collaborator
|
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. |
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. Do you have any suggestions? |
Collaborator
|
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds a small info about the api in the README.md
Additionally it adds the openapi specification of the API.
See #32