using doc-forge

mcp_docs/modules/openapi_first.loader.json

@@ -0,0 +1,79 @@
+{
+  "module": "openapi_first.loader",
+  "content": {
+    "path": "openapi_first.loader",
+    "docstring": "openapi_first.loaders\n=============================\n\nOpenAPI specification loading and validation utilities.\n\nThis module is responsible for loading an OpenAPI 3.x specification\nfrom disk and validating it before it is used by the application.\n\nIt enforces the principle that an invalid or malformed OpenAPI document\nmust never reach the routing or runtime layers.\n\nDesign principles\n-----------------\n- OpenAPI is treated as an authoritative contract.\n- Invalid specifications fail fast at application startup.\n- Supported formats are JSON and YAML.\n- Validation errors are surfaced clearly and early.\n\nThis module intentionally does NOT:\n-----------------------------------\n- Modify the OpenAPI document\n- Infer missing fields\n- Generate models or code\n- Perform request/response validation at runtime",
+    "objects": {
+      "json": {
+        "name": "json",
+        "kind": "alias",
+        "path": "openapi_first.loader.json",
+        "signature": "<bound method Alias.signature of Alias('json', 'json')>",
+        "docstring": null
+      },
+      "Path": {
+        "name": "Path",
+        "kind": "alias",
+        "path": "openapi_first.loader.Path",
+        "signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
+        "docstring": null
+      },
+      "Any": {
+        "name": "Any",
+        "kind": "alias",
+        "path": "openapi_first.loader.Any",
+        "signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
+        "docstring": null
+      },
+      "yaml": {
+        "name": "yaml",
+        "kind": "alias",
+        "path": "openapi_first.loader.yaml",
+        "signature": "<bound method Alias.signature of Alias('yaml', 'yaml')>",
+        "docstring": null
+      },
+      "validate_spec": {
+        "name": "validate_spec",
+        "kind": "alias",
+        "path": "openapi_first.loader.validate_spec",
+        "signature": "<bound method Alias.signature of Alias('validate_spec', 'openapi_spec_validator.validate_spec')>",
+        "docstring": null
+      },
+      "OpenAPIFirstError": {
+        "name": "OpenAPIFirstError",
+        "kind": "class",
+        "path": "openapi_first.loader.OpenAPIFirstError",
+        "signature": "<bound method Alias.signature of Alias('OpenAPIFirstError', 'openapi_first.errors.OpenAPIFirstError')>",
+        "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."
+      },
+      "OpenAPISpecLoadError": {
+        "name": "OpenAPISpecLoadError",
+        "kind": "class",
+        "path": "openapi_first.loader.OpenAPISpecLoadError",
+        "signature": "<bound method Class.signature of Class('OpenAPISpecLoadError', 38, 45)>",
+        "docstring": "Raised when an OpenAPI specification cannot be loaded or validated.\n\nThis error indicates that the OpenAPI document is unreadable,\nmalformed, or violates the OpenAPI 3.x specification."
+      },
+      "load_openapi": {
+        "name": "load_openapi",
+        "kind": "function",
+        "path": "openapi_first.loader.load_openapi",
+        "signature": "<bound method Function.signature of Function('load_openapi', 48, 107)>",
+        "docstring": "Load and validate an OpenAPI 3.x specification from disk.\n\nThe specification is parsed based on file extension and validated\nusing a strict OpenAPI schema validator. Any error results in an\nimmediate exception, preventing application startup.\n\nParameters\n----------\npath : str or pathlib.Path\n    Filesystem path to an OpenAPI specification file.\n    Supported extensions:\n    - `.json`\n    - `.yaml`\n    - `.yml`\n\nReturns\n-------\ndict\n    Parsed and validated OpenAPI specification.\n\nRaises\n------\nOpenAPISpecLoadError\n    If the file does not exist, cannot be parsed, or fails\n    OpenAPI schema validation."
+      },
+      "Dict": {
+        "name": "Dict",
+        "kind": "alias",
+        "path": "openapi_first.loader.Dict",
+        "signature": "<bound method Alias.signature of Alias('Dict', 'typing.Dict')>",
+        "docstring": null
+      },
+      "Union": {
+        "name": "Union",
+        "kind": "alias",
+        "path": "openapi_first.loader.Union",
+        "signature": "<bound method Alias.signature of Alias('Union', 'typing.Union')>",
+        "docstring": null
+      }
+    }
+  }
+}