30 lines
2.2 KiB
JSON
30 lines
2.2 KiB
JSON
{
|
|
"module": "openapi_first.errors",
|
|
"content": {
|
|
"path": "openapi_first.errors",
|
|
"docstring": "openapi_first.errors\n============================\n\nCustom exceptions for OpenAPI-first FastAPI applications.\n\nThis module defines a small hierarchy of explicit, intention-revealing\nexceptions used to signal contract violations between an OpenAPI\nspecification and its Python implementation.\n\nDesign principles\n-----------------\n- Errors represent *programmer mistakes*, not runtime conditions.\n- All errors are raised during application startup.\n- Messages are actionable and suitable for CI/CD output.\n- Exceptions are explicit rather than reused from generic built-ins.\n\nThese errors should normally cause immediate application failure.",
|
|
"objects": {
|
|
"OpenAPIFirstError": {
|
|
"name": "OpenAPIFirstError",
|
|
"kind": "class",
|
|
"path": "openapi_first.errors.OpenAPIFirstError",
|
|
"signature": "<bound method Class.signature of Class('OpenAPIFirstError', 21, 32)>",
|
|
"docstring": "Base exception for all OpenAPI-first enforcement errors.\n\nThis exception exists to allow callers, test suites, and CI pipelines\nto catch and distinguish OpenAPI contract violations from unrelated\nruntime errors.\n\nAll exceptions raised by the OpenAPI-first core should inherit from\nthis type."
|
|
},
|
|
"MissingOperationHandler": {
|
|
"name": "MissingOperationHandler",
|
|
"kind": "class",
|
|
"path": "openapi_first.errors.MissingOperationHandler",
|
|
"signature": "<bound method Class.signature of Class('MissingOperationHandler', 35, 72)>",
|
|
"docstring": "Raised when an OpenAPI operation cannot be resolved to a handler.\n\nThis error occurs when:\n- An OpenAPI operation does not define an operationId, or\n- An operationId is defined but no matching function exists in the\n provided routes module.\n\nThis represents a violation of the OpenAPI-first contract and\nindicates that the specification and implementation are out of sync."
|
|
},
|
|
"Optional": {
|
|
"name": "Optional",
|
|
"kind": "alias",
|
|
"path": "openapi_first.errors.Optional",
|
|
"signature": "<bound method Alias.signature of Alias('Optional', 'typing.Optional')>",
|
|
"docstring": null
|
|
}
|
|
}
|
|
}
|
|
} |