[BUG]: fix bad OpenAPI generation #3445
Merged
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.
Description of changes
PR #3310 broke the OpenAPI spec by generating a snippet for a request body that included:
This
$ref
is invalid because the corresponding$def
was placed as a sibling to this fragment, rather than at the top level of the document ($ref
s are always absolute). A thread where others ran into the same issue: https://community.sanicframework.org/t/problem-with-generated-openapi-schema-via-pydantic/1223Test plan
How are these changes tested?
pytest
for python,yarn test
for js,cargo test
for rustThe
genapi
JS script now runs successfully.Documentation Changes
Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?
n/a