Enhancement: Generate raises HTTPExceptions as OpenAPI components
Summary
@get(raises=[NotFoundException])
def endpoint(): ......seems to inject each declared raises entry as duplication into the generated OpenAPI spec:
"404": {
"description": "Nothing matches the given URI",
"content": {
"application/json": {
"schema": {
"properties": {
"status_code": {
"type": "integer"
},
"detail": {
"type": "string"
},
"extra": {
"additionalProperties": {},
"type": [
"null",
"object",
"array"
]
}
},
"type": "object",
"required": [
"detail",
"status_code"
],
"description": "Not Found Exception",
"examples": {
"NotFoundException": {
"value": {
"status_code": 404,
"detail": "Not Found",
"extra": {}
}
}
}
}
}
}
},That's quite lengthy, consider 100 endpoints and it's going to be there 100 times.
Basic Example
Could these be injected into the components section, rather:
"components": {
"schemas": {
"NotFoundException": {
"description": "Not Found Exception",
"type": "object",
"properties": {
"status_code": {
"type": "integer"
},
"detail": {
"type": "string"
},
"extra": {
"additionalProperties": {},
"type": [
"null",
"object",
"array"
]
}
},
"required": [
"detail",
"status_code"
],
"examples": {
"NotFoundException": {
"value": {
"status_code": 404,
"detail": "Not Found",
"extra": {}
}
}
}Then the references much become much shorter:
"404": {
"description": "Nothing matches the given URI",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundException"
}
}
}
},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