Allow documenting alternative response content-type #77
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.
I'm interested in using quart-schema as a drop-in replacement for apiflask to generate OpenAPI documentation for my application.
So far, I've been able to use
validate_response
to generate relevant documentation for all of myapplication/json
endpoints.When it comes to my other content-types, such as
text/event-stream
, I've been able to successfully document the headers with Pydantic models with the signature:However, this yields me the following OpenAPI docs:
Instead of documenting the response as
application/json
, I would like it to use the relevant literal from the Headers class that I've provided. I've added a simple test case to demonstrate.