Add request details to examples #4445
Merged
Conversation
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
miguelgrinberg
force-pushed
the
add-heading-lines-to-examples
branch
from
c6d0dfd to
efe620e
Compare
miguelgrinberg
force-pushed
the
add-heading-lines-to-examples
branch
from
efe620e to
85209ed
Compare
|
Following you can find the validation results for the APIs you have changed.
You can validate these APIs yourself by using the |
2 similar comments
|
Following you can find the validation results for the APIs you have changed.
You can validate these APIs yourself by using the |
|
Following you can find the validation results for the APIs you have changed.
You can validate these APIs yourself by using the |
JoshMock
approved these changes
Jun 3, 2025
If you remove the generated spec and openapi files and the example yaml files what remains is actually not a big change. This is just to use this new |
miguelgrinberg
force-pushed
the
add-heading-lines-to-examples
branch
from
85209ed to
7abd582
Compare
|
Following you can find the validation results for the APIs you have changed.
You can validate these APIs yourself by using the |
|
The backport to To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-9.0 9.0
# Navigate to the new working tree
cd .worktrees/backport-9.0
# Create a new branch
git switch --create backport-4445-to-9.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 ed5a4ebefe6e41642ae19a23d9cd43c971ac358f
# Push it to GitHub
git push --set-upstream origin backport-4445-to-9.0
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-9.0Then, create a pull request where the |
miguelgrinberg
added a commit
that referenced
this pull request
Jun 6, 2025
* add request heading line to request examples * add request heading line to response examples * changes to the compiler to include the request heading
miguelgrinberg
added a commit
that referenced
this pull request
Jun 6, 2025
This was referenced Jun 6, 2025
miguelgrinberg
added a commit
that referenced
this pull request
Jun 10, 2025
* add request heading line to request examples * add request heading line to response examples * changes to the compiler to include the request heading
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 change adds the
method_requestfield to all the example request YAML files. This field existed in these examples, but it was commented out. In addition, it adds this field to any response examples that have the information in their description field.The compiler was expanded to recognize this field as optional in all examples. The OpenAPI generator was expanded to use this field to generate the
x-codeSamplesextension, which would replace the autogenerated curl code in the blue box that bump adds in the top right of each endpoint.A follow-up change could add language versions of the example using the request converter.
The following is a list of request and/or response examples that could not be expanded to include the
method_requestfield that would be needed for rendering in the docs. These should be manually reviewed and fixed to include this field: