Enhancement: Allow customizing HTTPException content in OpenAPI spec
Summary
How HTTPExceptions get into OpenAPI spec is done is in
litestar/litestar/_openapi/responses.py
Lines 280 to 285 in 1475955
The fields written (status_code, detail, extra) is hard-coded there.
Allow generating the schema from a callable, that can be customized.
Basic Example
Just to give an idea:
def generate_schema(exc: HTTPException):
...the logic here...
app = Litestar(exception_schema_generator=generate_schema)Decoupling schema generation from the exception itself would work also for the builtin errors that Litestar might throw, like ValidationException.
Drawbacks and Impact
No response
Unresolved questions
No response
litestar-org / litestar
Production-ready, Light, Flexible and Extensible ASGI API framework | Effortlessly Build Performant APIs
5.5k
How does funding with Polar work?
1
Pay now to fund the work behind this issue.
2
Get updates on progress being made.
3
Maintainer is rewarded once the issue is completed.
FAQ
Backer
You're funding impactful open source efforts
Contributor
You want to contribute to this effort
Maintainer
You want to get funding like this too