{
  "module": "openapi_first.client",
  "content": {
    "path": "openapi_first.client",
    "docstring": "openapi_first.client\n====================\n\nOpenAPI-first HTTP client for contract-driven services.\n\nThis module provides `OpenAPIClient`, a thin, strict HTTP client that\nderives all callable operations directly from an OpenAPI 3.x specification.\n\nIt is the client counterpart to `OpenAPIFirstApp`.\n\nCore principles\n---------------\n- The OpenAPI specification is the single source of truth.\n- Each operationId becomes a callable Python method.\n- No implicit schema mutation or inference.\n- No code generation step.\n- Minimal abstraction over httpx.\n\nWhat this module does\n---------------------\n- Parses an OpenAPI 3.x specification.\n- Dynamically creates one callable per operationId.\n- Enforces presence of:\n  - servers\n  - paths\n  - operationId\n- Formats path parameters safely.\n- Handles JSON request bodies explicitly.\n- Returns raw `httpx.Response` objects.\n\nWhat this module does NOT do\n----------------------------\n- It does not generate client code.\n- It does not validate request/response schemas.\n- It does not deserialize responses.\n- It does not retry requests.\n- It does not implement authentication helpers.\n- It does not assume non-2xx responses are failures.\n\nIntended usage\n--------------\nThis client is designed for:\n\n- Service-to-service communication\n- Integration testing\n- Contract-driven internal SDK usage\n- Systems that want OpenAPI-first symmetry with `OpenAPIFirstApp`\n\nDesign constraints\n------------------\n- Only the first server in the OpenAPI `servers` list is used if\n  `base_url` is not explicitly provided.\n- Only explicitly declared request bodies are allowed.\n- `application/json` is handled natively; other media types are sent as raw content.\n- All responses are returned as-is.",
    "objects": {
      "Any": {
        "name": "Any",
        "kind": "alias",
        "path": "openapi_first.client.Any",
        "signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
        "docstring": null
      },
      "Callable": {
        "name": "Callable",
        "kind": "alias",
        "path": "openapi_first.client.Callable",
        "signature": "<bound method Alias.signature of Alias('Callable', 'typing.Callable')>",
        "docstring": null
      },
      "Dict": {
        "name": "Dict",
        "kind": "alias",
        "path": "openapi_first.client.Dict",
        "signature": "<bound method Alias.signature of Alias('Dict', 'typing.Dict')>",
        "docstring": null
      },
      "Optional": {
        "name": "Optional",
        "kind": "alias",
        "path": "openapi_first.client.Optional",
        "signature": "<bound method Alias.signature of Alias('Optional', 'typing.Optional')>",
        "docstring": null
      },
      "urljoin": {
        "name": "urljoin",
        "kind": "alias",
        "path": "openapi_first.client.urljoin",
        "signature": "<bound method Alias.signature of Alias('urljoin', 'urllib.parse.urljoin')>",
        "docstring": null
      },
      "httpx": {
        "name": "httpx",
        "kind": "alias",
        "path": "openapi_first.client.httpx",
        "signature": "<bound method Alias.signature of Alias('httpx', 'httpx')>",
        "docstring": null
      },
      "OpenAPIFirstError": {
        "name": "OpenAPIFirstError",
        "kind": "class",
        "path": "openapi_first.client.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."
      },
      "OpenAPIClientError": {
        "name": "OpenAPIClientError",
        "kind": "class",
        "path": "openapi_first.client.OpenAPIClientError",
        "signature": "<bound method Class.signature of Class('OpenAPIClientError', 67, 68)>",
        "docstring": "Raised when an OpenAPI client operation fails."
      },
      "OpenAPIClient": {
        "name": "OpenAPIClient",
        "kind": "class",
        "path": "openapi_first.client.OpenAPIClient",
        "signature": "<bound method Class.signature of Class('OpenAPIClient', 71, 291)>",
        "docstring": "OpenAPI-first HTTP client (httpx-based).\n\nThis client derives all callable methods directly from an OpenAPI 3.x\nspecification. Each operationId becomes a method on the client\ninstance.\n\nDesign principles\n-----------------\n- One callable per operationId\n- Explicit parameters (path, query, headers, body)\n- No implicit schema inference or mutation\n- Returns raw httpx.Response objects\n- No response validation or deserialization\n\nParameters\n----------\nspec : dict\n    Parsed OpenAPI 3.x specification.\nbase_url : str | None\n    Base URL of the target service. If omitted, the first entry\n    in the OpenAPI `servers` list is used.\nclient : httpx.Client | None\n    Optional preconfigured httpx client instance.\n\nRaises\n------\nOpenAPIClientError\n    If:\n    - No servers are defined and base_url is not provided\n    - OpenAPI spec has no paths\n    - An operation is missing operationId\n    - Duplicate operationIds are detected\n    - Required path parameters are missing\n    - Required request body is missing\n\n Example\n-------\n```python\nfrom openapi_first import loader, client\n\nspec = loader.load_openapi(\"openapi.yaml\")\n\napi = client.OpenAPIClient(\n    spec=spec,\n    base_url=\"http://localhost:8000\",\n)\n\n# Call operationId: getUser\nresponse = api.getUser(\n    path_params={\"user_id\": 123}\n)\n\nprint(response.status_code)\nprint(response.json())\n\n# Call operationId: createUser\nresponse = api.createUser(\n    body={\"name\": \"Bob\"}\n)\n\nprint(response.status_code)\n```",
        "members": {
          "spec": {
            "name": "spec",
            "kind": "attribute",
            "path": "openapi_first.client.OpenAPIClient.spec",
            "signature": null,
            "docstring": null
          },
          "base_url": {
            "name": "base_url",
            "kind": "attribute",
            "path": "openapi_first.client.OpenAPIClient.base_url",
            "signature": null,
            "docstring": null
          },
          "client": {
            "name": "client",
            "kind": "attribute",
            "path": "openapi_first.client.OpenAPIClient.client",
            "signature": null,
            "docstring": null
          },
          "operations": {
            "name": "operations",
            "kind": "function",
            "path": "openapi_first.client.OpenAPIClient.operations",
            "signature": "<bound method Function.signature of Function('operations', 160, 161)>",
            "docstring": null
          }
        }
      }
    }
  }
}