From a6584210a45df17853dce087485b8ac4b782abe4 Mon Sep 17 00:00:00 2001
From: Johan <johan.thillemann@skypuzzler.com>
Date: Mon, 24 Mar 2025 11:32:00 +0100
Subject: [PATCH] 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.
---
 fastapi/openapi/utils.py | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/fastapi/openapi/utils.py b/fastapi/openapi/utils.py
index 808646cc2..effb3b12d 100644
--- a/fastapi/openapi/utils.py
+++ b/fastapi/openapi/utils.py
@@ -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",