Now generating API method documentation from OpenAPI schema. #119
+1,186
−537
Conversation
This file contains 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
…enerated from openapi.yaml
… object properties
…ints and RequestCreatedEvent
…ze probability of correct rendering in several contexts (e.g. github, vscode)
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.
With this change, both data model details and API method descriptions are now being generated from the OpenAPI specification:
specs/v3/openapi.yaml.specs/v3/index.mdnow contains more general information (like introduction and chapters on exchange and footprint lifecycle) and the changelog.There is still a fair number of dead links, but these can be better be fixed on a regular maintenance branch.