Create schema components for each response schema #7303
Closed
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.
Always wrap response in a component schema, also paginated once, to improve processability of API code generators. Adresses #7299
Description
In djangorestframework's
AutoSchemaI modified the schema generation to always Provide a wrappingOperationIdResponseschema component. That serves the purpose, that if the schema generator add's more fields to the response, like pagination properties the response doesn't have to inline those fields, but instead always points to a schema component.That makes the resulting openapi specification more processable by API client generators like openapi-generator.
Inlined responses would lead to fallback type names like
InlinedRespose2000- see #7299