Skip to content

fix: OpenAPI Swagger docs generation in certain scenarios #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

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

Merged
EdgyEdgemond merged 2 commits into from
Aug 26, 2025
Merged

fix: OpenAPI Swagger docs generation in certain scenarios #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d3c303
fix: Fix OpenAPI Swagger docs in certain scenarios
ajstewart Aug 21, 2025
a5dac37
Ignore ARG001 in tests
ajstewart Aug 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/fastapi_problem/handler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,15 @@ def wrapper() -> dict:
"""Wrapper."""
res = func()

if "components" not in res:
if not res["paths"]:
# If there are no paths, we don't need to add any responses
return res

if "components" not in res:
res["components"] = {"schemas": {}}
elif "schemas" not in res["components"]:
res["components"]["schemas"] = {}

validation_error = problem_component(
"RequestValidationError",
required=["errors"],
Expand Down
187 changes: 185 additions & 2 deletions tests/test_handler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@

import httpx
import pytest
from fastapi import FastAPI
from fastapi import Depends, FastAPI
from fastapi.exceptions import RequestValidationError
from fastapi.security import HTTPBearer
from starlette.exceptions import HTTPException

from fastapi_problem import error, handler
Expand Down Expand Up @@ -702,7 +703,7 @@ async def status(_a: str) -> dict:
}


async def test_customise_openapi_handles_no_components():
async def test_customise_openapi_handles_no_components_no_paths():
app = FastAPI()

app.openapi = handler.customise_openapi(app.openapi)
Expand All @@ -712,6 +713,188 @@ async def test_customise_openapi_handles_no_components():
assert "components" not in res


async def test_customise_openapi_handles_no_components_no_422():
app = FastAPI()

@app.get("/status")
async def status() -> dict:
return {}

app.openapi = handler.customise_openapi(app.openapi)

res = app.openapi()

assert res["components"]["schemas"]["HTTPValidationError"] == {
"properties": {
"title": {
"type": "string",
"title": "Problem title",
},
"type": {
"type": "string",
"title": "Problem type",
},
"status": {
"type": "integer",
"title": "Status code",
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError",
},
},
},
"type": "object",
"required": [
"type",
"title",
"status",
"errors",
],
"title": "RequestValidationError",
}
assert "Problem" in res["components"]["schemas"]

assert res["paths"]["/status"]["get"]["responses"] == {
"200": {
"content": {
"application/json": {
"schema": {
"title": "Response Status Status Get",
"type": "object",
},
},
},
"description": "Successful Response",
},
"4XX": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem",
},
"example": {
"title": "User facing error message.",
"detail": "Additional error context.",
"type": "client-error-type",
"status": 400,
},
},
},
"description": "Client Error",
},
"5XX": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem",
},
"example": {
"title": "User facing error message.",
"detail": "Additional error context.",
"type": "server-error-type",
"status": 500,
},
},
},
"description": "Server Error",
},
}


async def test_customise_openapi_handles_security_components_no_422():
bearer_scheme = HTTPBearer(bearerFormat="JWT")
app = FastAPI()

@app.get("/status")
async def status(bearer: str = Depends(bearer_scheme)) -> dict: # noqa: ARG001
return {}

app.openapi = handler.customise_openapi(app.openapi)

res = app.openapi()

assert res["components"]["schemas"]["HTTPValidationError"] == {
"properties": {
"title": {
"type": "string",
"title": "Problem title",
},
"type": {
"type": "string",
"title": "Problem type",
},
"status": {
"type": "integer",
"title": "Status code",
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError",
},
},
},
"type": "object",
"required": [
"type",
"title",
"status",
"errors",
],
"title": "RequestValidationError",
}
assert "Problem" in res["components"]["schemas"]
assert "securitySchemes" in res["components"]

assert res["paths"]["/status"]["get"]["responses"] == {
"200": {
"content": {
"application/json": {
"schema": {
"title": "Response Status Status Get",
"type": "object",
},
},
},
"description": "Successful Response",
},
"4XX": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem",
},
"example": {
"title": "User facing error message.",
"detail": "Additional error context.",
"type": "client-error-type",
"status": 400,
},
},
},
"description": "Client Error",
},
"5XX": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem",
},
"example": {
"title": "User facing error message.",
"detail": "Additional error context.",
"type": "server-error-type",
"status": 500,
},
},
},
"description": "Server Error",
},
}


async def test_customise_openapi_generic_opt_out():
app = FastAPI()

Expand Down
Loading