📖 Generate OpenAPI 3.0 API documentation #545
Merged
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
Necessary to satisfy Swagger/OpenAPI validator. Signed-off-by: Sam Lucidi <[email protected]>
Signed-off-by: Sam Lucidi <[email protected]>
Signed-off-by: Sam Lucidi <[email protected]>
mansam
force-pushed
the
improve-swagger-docs
branch
from
ceb4fbb to
12b00a5
Compare
aufi
pushed a commit
to aufi/tackle2-hub
that referenced
this pull request
Oct 30, 2023
This PR represents a first step towards improving our automatically generated API documentation. It includes the following changes: * Adds general API level doc comments that are a requirement for Swagger/OpenAPI. * Adds missing godocs for parameters where they were missing. This was causing Swagger validation to fail and was preventing QE from successfully converting our Swagger 2 documentation to OpenAPI 3.0 * Fixes some incorrect parameter documentation * Adds a new target to convert our Swagger 2 documentation to OpenAPI 3.0 using the Swagger conversion API at `converter.swagger.io`. * Corrects the existing docs-swagger target command invocation. * Updates the redoc target to use the newly generated OpenAPI 3.0 documentation. --------- Signed-off-by: Sam Lucidi <[email protected]>
mansam
added
the
kind/documentation
mansam
changed the title
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 PR represents a first step towards improving our automatically generated API documentation. It includes the following changes:
converter.swagger.io.