We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
examples
Describe the bug
Example:
class OrganizationPostSchema(Schema): email: EmailStr | None = Field(default=None, examples=["[email protected]"])
it does not show in the generated OpenAPI docs. Although I noticed that you can pass it as:
class OrganizationPostSchema(Schema): email: EmailStr | None = Field(default=None, example="[email protected]")
This will show it like this:
But example is not a valid parameter for Pydantic's Field class. Therefore the IDE and mypy will show it as an error.
example
Versions (please complete the following information):
The preferred solution would be to display examples the same way as you do currently with example
The text was updated successfully, but these errors were encountered:
No branches or pull requests
Describe the bug
Example:
it does not show in the generated OpenAPI docs.
Although I noticed that you can pass it as:
This will show it like this:
But
example
is not a valid parameter for Pydantic's Field class.Therefore the IDE and mypy will show it as an error.
Versions (please complete the following information):
The preferred solution would be to display
examples
the same way as you do currently withexample
The text was updated successfully, but these errors were encountered: