Add transform API examples via overlay #2755
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
lcawl
force-pushed
the
doc-example-overlays
branch
from
b040f69 to
46eebe7
Compare
lcawl
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.
Relates to #2482
This PR demonstrates a way we could short-term use overlays to insert examples into the openAPI document.
For now the updated OpenAPI document is generated by using the "make overlay-docs" command and it's stored in the output folder. Long-term we could potentially perform that processing as part of the OpenAPI generator or as part of the deployment process so that we didn't need to maintain otherwise identical files.