fix: Ensure generic swagger problem definitions inherit documentation uri template and strict settings.

Author: EdgyEdgemond

src/fastapi_problem/handler.py

@@ -33,14 +33,15 @@ class Example(t.NamedTuple):
     title: str
     type_: str
     status: int
+    detail: str
 
 
 def _swagger_problem_response(description: str, examples: list[Example]) -> dict:
     examples_ = {
         ex.title: {
             "value": {
                 "title": ex.title,
-                "detail": "Additional error context.",
+                "detail": ex.detail,
                 "type": ex.type_,
                 "status": ex.status,
             },
@@ -79,6 +80,7 @@ def _generate_swagger_response(
                 title=d["title"],
                 type_=d["type"],
                 status=d["status"],
+                detail=d["detail"],
             ),
         )
     return _swagger_problem_response(
@@ -87,7 +89,11 @@ def _generate_swagger_response(
     )
 
 
-def generate_swagger_response(*exceptions: type[Problem], documentation_uri_template: str = "", strict: bool = False) -> dict:
+def generate_swagger_response(
+    *exceptions: type[Problem],
+    documentation_uri_template: str = "",
+    strict: bool = False,
+) -> dict:
     warn(
         "Direct calls to generate_swagger_response are being deprecated, use `eh.generate_swagger_response(...)` instead.",
         FutureWarning,
@@ -109,7 +115,13 @@ def generate_swagger_response(self, *exceptions: type[Problem]) -> dict:
         )
 
 
-def customise_openapi(func: t.Callable[..., dict], *, generic_defaults: bool = True) -> t.Callable[..., dict]:
+def customise_openapi(
+    func: t.Callable[..., dict],
+    *,
+    documentation_uri_template: str = "",
+    strict: bool = False,
+    generic_defaults: bool = True,
+) -> t.Callable[..., dict]:
     """Customize OpenAPI schema."""
 
     def wrapper() -> dict:
@@ -198,23 +210,39 @@ def wrapper() -> dict:
                         "content"
                     ].pop("application/json")
                 if generic_defaults:
+                    user_error = Problem(
+                        "User facing error message.",
+                        type_="client-error-type",
+                        status=400,
+                        detail="Additional error context.",
+                    )
+                    d = user_error.marshal(uri=documentation_uri_template, strict=strict)
                     details["responses"]["4XX"] = _swagger_problem_response(
                         description="Client Error",
                         examples=[
                             Example(
-                                title="User facing error message.",
-                                type_="client-error-type",
-                                status=400,
+                                title=d["title"],
+                                type_=d["type"],
+                                status=d["status"],
+                                detail=d["detail"],
                             ),
                         ],
                     )
+                    server_error = Problem(
+                        "User facing error message.",
+                        type_="server-error-type",
+                        status=500,
+                        detail="Additional error context.",
+                    )
+                    d = server_error.marshal(uri=documentation_uri_template, strict=strict)
                     details["responses"]["5XX"] = _swagger_problem_response(
                         description="Server Error",
                         examples=[
                             Example(
-                                title="User facing error message.",
-                                type_="server-error-type",
-                                status=500,
+                                title=d["title"],
+                                type_=d["type"],
+                                status=d["status"],
+                                detail=d["detail"],
                             ),
                         ],
                     )
@@ -324,7 +352,12 @@ def add_exception_handler(  # noqa: PLR0913
     app.add_exception_handler(RequestValidationError, eh)
 
     # Override default 422 with Problem schema
-    app.openapi = customise_openapi(app.openapi, generic_defaults=generic_swagger_defaults)
+    app.openapi = customise_openapi(
+        app.openapi,
+        generic_defaults=generic_swagger_defaults,
+        documentation_uri_template=eh.documentation_uri_template,
+        strict=eh.strict,
+    )
 
     return eh
 

tests/test_handler.py

@@ -452,6 +452,7 @@ def test_swagger_problem_response():
                 title="User facing error message.",
                 type_="client-error-type",
                 status=400,
+                detail="Additional error context.",
             ),
         ],
     ) == {
@@ -480,11 +481,13 @@ def test_swagger_problem_response_multiple_examples():
                 title="User facing error message.",
                 type_="client-error-type",
                 status=400,
+                detail="Additional error context.",
             ),
             handler.Example(
                 title="Another user facing error message.",
                 type_="another-client-error-type",
                 status=400,
+                detail="Additional error context.",
             ),
         ],
     ) == {
@@ -517,6 +520,25 @@ def test_swagger_problem_response_multiple_examples():
     }
 
 
+def test_generate_swagger_response_status_problem_deprecated():
+    assert handler.generate_swagger_response(error.BadRequestProblem) == {
+        "content": {
+            "application/problem+json": {
+                "schema": {
+                    "$ref": "#/components/schemas/Problem",
+                },
+                "example": {
+                    "title": "Base http exception.",
+                    "detail": "Additional error context.",
+                    "type": "bad-request-problem",
+                    "status": 400,
+                },
+            },
+        },
+        "description": "Bad Request",
+    }
+
+
 def test_generate_swagger_response_status_problem():
     eh = handler.new_exception_handler()
     assert eh.generate_swagger_response(error.BadRequestProblem) == {