docs: update openapi.yaml descriptions and version bump to 1.0.2#55
Open
cnadler86 wants to merge 1 commit intoZendure:mainfrom
Open
docs: update openapi.yaml descriptions and version bump to 1.0.2#55cnadler86 wants to merge 1 commit intoZendure:mainfrom
cnadler86 wants to merge 1 commit intoZendure:mainfrom
Conversation
…sion bump to 1.0.2
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
1 participant
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 PR updates the
openapi.yamlfile to match the property description from the documentation.Suggestion: it should be the other way around: it is easier to keep the
openapi.yamlfile updated and autogenerate the documentation with tools like openapi-to-md. You can even bind it to a pre-commit hook, so you don't forget to update the documentation.