Move error example to Error schema so it applies to all references

Author: beran-t

openapi-public.yml

@@ -2064,54 +2064,36 @@ components:
         application/json:
           schema:
             $ref: '#/components/schemas/Error'
-            example:
-              code: 400
-              message: 'Bad request: invalid or missing request parameters'
     '401':
       description: Authentication error
       content:
         application/json:
           schema:
             $ref: '#/components/schemas/Error'
-            example:
-              code: 401
-              message: 'Authentication error: missing or invalid API key'
     '403':
       description: Forbidden
       content:
         application/json:
           schema:
             $ref: '#/components/schemas/Error'
-            example:
-              code: 403
-              message: 'Forbidden: insufficient permissions'
     '404':
       description: Not found
       content:
         application/json:
           schema:
             $ref: '#/components/schemas/Error'
-            example:
-              code: 404
-              message: 'Not found: the requested resource does not exist'
     '409':
       description: Conflict
       content:
         application/json:
           schema:
             $ref: '#/components/schemas/Error'
-            example:
-              code: 409
-              message: 'Conflict: the resource is in a conflicting state'
     '500':
       description: Server error
       content:
         application/json:
           schema:
             $ref: '#/components/schemas/Error'
-            example:
-              code: 500
-              message: 'Server error: an unexpected error occurred'
   schemas:
     Error:
       required:
@@ -2126,6 +2108,9 @@ components:
           type: string
           description: Error
       type: object
+      example:
+        code: 400
+        message: 'Bad request: invalid or missing request parameters'
     EntryInfo:
       required:
       - path

scripts/generate_openapi_reference.py

@@ -1022,26 +1022,14 @@ def _singularize(word: str) -> str:
             responses["500"] = {"$ref": "#/components/responses/500"}
             fixes.append("/sandboxes/{sandboxID}/refreshes: added 500 response")
 
-    # 25. Add meaningful examples to error responses
-    error_examples = {
-        "400": {"code": 400, "message": "Bad request: invalid or missing request parameters"},
-        "401": {"code": 401, "message": "Authentication error: missing or invalid API key"},
-        "403": {"code": 403, "message": "Forbidden: insufficient permissions"},
-        "404": {"code": 404, "message": "Not found: the requested resource does not exist"},
-        "409": {"code": 409, "message": "Conflict: the resource is in a conflicting state"},
-        "500": {"code": 500, "message": "Server error: an unexpected error occurred"},
-    }
-    responses = spec.get("components", {}).get("responses", {})
-    for status, example in error_examples.items():
-        resp = responses.get(status)
-        if resp and "content" in resp:
-            schema = resp["content"].get("application/json", {}).get("schema")
-            if schema:
-                resp["content"]["application/json"]["schema"] = {
-                    **schema,
-                    "example": example,
-                }
-    fixes.append("Error responses: added example values for 400/401/403/404/409/500")
+    # 25. Add meaningful example to the Error schema (applies everywhere it's referenced)
+    error_schema = schemas.get("Error")
+    if error_schema and "example" not in error_schema:
+        error_schema["example"] = {
+            "code": 400,
+            "message": "Bad request: invalid or missing request parameters",
+        }
+        fixes.append("Error schema: added example values")
 
     if fixes:
         print(f"==> Fixed {len(fixes)} spec issues:")