Add REST API markdown docs based on openapi definition#363
Merged
lucas-koehler merged 1 commit intomainfrom Oct 25, 2024
Merged
Add REST API markdown docs based on openapi definition#363lucas-koehler merged 1 commit intomainfrom
lucas-koehler merged 1 commit intomainfrom
Conversation
Use the openapi-generator-cli to generate markdown docs from the openapi.json. Also document how this works and add a hint that the generator supports various doc and code languages.
lucas-koehler
force-pushed
the
lk/openapi-readme-generation
branch
from
249612d to
8215bf1
Compare
jfaltermeier
approved these changes
Oct 25, 2024
Contributor
jfaltermeier
left a comment
jfaltermeier
left a comment
There was a problem hiding this comment.
LGTM. Regeneration worked on my side as well.
The generated markdown files don’t follow our formatting rules, but since we shouldn’t be editing generated files manually anyway, I’m not sure if it’s an issue. What’s your take on this?
Contributor
Author
We could format them using prettier on the command line. However, I don't see any reason to do this for now because - as you stated - these files should not be edited manually anyway. Thus, I would not add a step in the documentation for now. |
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
2 participants
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.
Use the openapi-generator-cli to generate markdown docs from the openapi.json.
Also document how this works and add a hint that the generator supports
various doc and code languages.