{ "module": "openapi_first.templates.model_app.test_model_app", "content": { "path": "openapi_first.templates.model_app.test_model_app", "docstring": "End-to-end tests for the OpenAPI-first model CRUD example app.\n\nThese tests validate that all CRUD operations behave correctly\nagainst the in-memory mock data store using Pydantic models.\n- OpenAPI specification loading\n- OperationId-driven route binding on the server\n- OperationId-driven client invocation\n- Pydantic model-based request and response handling\n\nAll CRUD operations are exercised against an in-memory mock data store\nbacked by Pydantic domain models.\n\nThe tests assume:\n- OpenAPI-first route binding\n- Pydantic model validation\n- In-memory storage (no persistence guarantees)\n- Deterministic behavior in a single process", "objects": { "TestClient": { "name": "TestClient", "kind": "alias", "path": "openapi_first.templates.model_app.test_model_app.TestClient", "signature": "", "docstring": null }, "app": { "name": "app", "kind": "alias", "path": "openapi_first.templates.model_app.test_model_app.app", "signature": "", "docstring": null }, "load_openapi": { "name": "load_openapi", "kind": "function", "path": "openapi_first.templates.model_app.test_model_app.load_openapi", "signature": "", "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." }, "OpenAPIClient": { "name": "OpenAPIClient", "kind": "class", "path": "openapi_first.templates.model_app.test_model_app.OpenAPIClient", "signature": "", "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.templates.model_app.test_model_app.OpenAPIClient.spec", "signature": "", "docstring": null }, "base_url": { "name": "base_url", "kind": "attribute", "path": "openapi_first.templates.model_app.test_model_app.OpenAPIClient.base_url", "signature": "", "docstring": null }, "client": { "name": "client", "kind": "attribute", "path": "openapi_first.templates.model_app.test_model_app.OpenAPIClient.client", "signature": "", "docstring": null }, "operations": { "name": "operations", "kind": "function", "path": "openapi_first.templates.model_app.test_model_app.OpenAPIClient.operations", "signature": "", "docstring": null } } }, "client": { "name": "client", "kind": "attribute", "path": "openapi_first.templates.model_app.test_model_app.client", "signature": null, "docstring": null }, "spec": { "name": "spec", "kind": "attribute", "path": "openapi_first.templates.model_app.test_model_app.spec", "signature": null, "docstring": null }, "test_list_items_initial": { "name": "test_list_items_initial", "kind": "function", "path": "openapi_first.templates.model_app.test_model_app.test_list_items_initial", "signature": "", "docstring": "Initial items should be present." }, "test_get_item": { "name": "test_get_item", "kind": "function", "path": "openapi_first.templates.model_app.test_model_app.test_get_item", "signature": "", "docstring": "Existing item should be retrievable by ID." }, "test_create_item": { "name": "test_create_item", "kind": "function", "path": "openapi_first.templates.model_app.test_model_app.test_create_item", "signature": "", "docstring": "Creating a new item should return the created entity." }, "test_update_item": { "name": "test_update_item", "kind": "function", "path": "openapi_first.templates.model_app.test_model_app.test_update_item", "signature": "", "docstring": "Updating an item should replace its values." }, "test_delete_item": { "name": "test_delete_item", "kind": "function", "path": "openapi_first.templates.model_app.test_model_app.test_delete_item", "signature": "", "docstring": "Deleting an item should remove it from the store." } } } }