happyz
/
fastapi
mirror of https://github.com/tiangolo/fastapi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Descriptions for ValidationError and HTTPValidationError in OpenAPI schema 

When schemata are used for codegen downstream, this alleviates the need
to modify the `ValidationError` and `HTTPValidationError` models to satisfy
linters that require descriptions on modules/classes.
This commit is contained in:
Johan 2025-03-24 11:32:00 +01:00
parent 628c34e0ca
commit a6584210a4
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
fastapi/openapi/utils.py
View File

@ -41,6 +41,7 @@ from typing_extensions import Literal
validation_error_definition = {
"title": "ValidationError",
"type": "object",
"description": "A message detailing how and where the input diverges from the schema.",
"properties": {
"loc": {
"title": "Location",
@ -48,7 +49,11 @@ validation_error_definition = {
"items": {"anyOf": [{"type": "string"}, {"type": "integer"}]},
},
"msg": {"title": "Message", "type": "string"},
"type": {"title": "Error Type", "type": "string"},
"type": {
"title": "Error Type",
"type": "string",
"description": "Free-form; when type is 'missing', it pertains to absent required fields.",
},
},
"required": ["loc", "msg", "type"],
}
@ -56,6 +61,7 @@ validation_error_definition = {
validation_error_response_definition = {
"title": "HTTPValidationError",
"type": "object",
"description": "A collection of messages detailing errors in the input.",
"properties": {
"detail": {
"title": "Detail",