Vishesh 'ironeagle' Bangotra
621f10409e
Squash-merge lib-standardisation: adopt repo standards across packaging, tooling, docs, and CI. - standardize pyproject.toml (canonical packaging, lint config, extras, GSDFC pydoclint) - add py.typed marker, modernize type hints and Google-style docstrings - nest generated docs under docs/lib and docs/mcp; add hand-written wiki - adopt standard Type A PyPI CI pipeline (tag==version guard + quality gate) - promote generated CHANGELOG.md; bump version to 0.0.7
198 lines
9.5 KiB
JSON
198 lines
9.5 KiB
JSON
{
|
|
"module": "openapi_first.templates.vet_app.routes",
|
|
"content": {
|
|
"path": "openapi_first.templates.vet_app.routes",
|
|
"docstring": "Veterinary Clinic route handlers bound via OpenAPI operationId.\n\nHandlers explicitly control HTTP response status codes to ensure runtime\nbehavior matches the OpenAPI contract. Domain models defined using\nPydantic are used for request and response payloads.\n\nNo routing decorators, path definitions, or implicit framework behavior\nappear in this module. All routing, HTTP methods, and schemas are defined\nin the OpenAPI specification.",
|
|
"objects": {
|
|
"list_parents": {
|
|
"name": "list_parents",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.list_parents",
|
|
"signature": "list_parents(limit: int = 20, offset: int = 0) -> dict",
|
|
"docstring": "List parents (paginated).\n\nParameters\n----------\nlimit : int\n Maximum number of records to return.\noffset : int\n Number of records to skip.\n\nReturns\n-------\ndict\n Paginated response with ``total`` and ``items``."
|
|
},
|
|
"create_parent": {
|
|
"name": "create_parent",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.create_parent",
|
|
"signature": "create_parent(payload: ParentCreate, response: Response) -> Parent",
|
|
"docstring": "Create a parent.\n\nParameters\n----------\npayload : ParentCreate\n Parent data excluding the ``id`` field.\nresponse : Response\n Response object used to set the HTTP status code.\n\nReturns\n-------\nParent\n The newly created parent."
|
|
},
|
|
"get_parent": {
|
|
"name": "get_parent",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.get_parent",
|
|
"signature": "get_parent(id: int) -> Parent",
|
|
"docstring": "Retrieve a single parent by ID.\n\nParameters\n----------\nid : int\n Identifier of the parent.\n\nReturns\n-------\nParent\n The requested parent.\n\nRaises\n------\nHTTPException\n 404 if the parent does not exist."
|
|
},
|
|
"update_parent": {
|
|
"name": "update_parent",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.update_parent",
|
|
"signature": "update_parent(id: int, payload: ParentCreate) -> Parent",
|
|
"docstring": "Update an existing parent.\n\nParameters\n----------\nid : int\n Identifier of the parent.\npayload : ParentCreate\n Updated parent data.\n\nReturns\n-------\nParent\n The updated parent.\n\nRaises\n------\nHTTPException\n 404 if the parent does not exist."
|
|
},
|
|
"delete_parent": {
|
|
"name": "delete_parent",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.delete_parent",
|
|
"signature": "delete_parent(id: int, response: Response) -> None",
|
|
"docstring": "Delete an existing parent.\n\nParameters\n----------\nid : int\n Identifier of the parent.\nresponse : Response\n Response object used to set the HTTP status code.\n\nRaises\n------\nHTTPException\n 404 if the parent does not exist."
|
|
},
|
|
"list_vets": {
|
|
"name": "list_vets",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.list_vets",
|
|
"signature": "list_vets(limit: int = 20, offset: int = 0)",
|
|
"docstring": "List vets (paginated)."
|
|
},
|
|
"create_vet": {
|
|
"name": "create_vet",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.create_vet",
|
|
"signature": "create_vet(payload: VetCreate, response: Response)",
|
|
"docstring": "Create a vet."
|
|
},
|
|
"get_vet": {
|
|
"name": "get_vet",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.get_vet",
|
|
"signature": "get_vet(id: int)",
|
|
"docstring": "Retrieve a single vet by ID."
|
|
},
|
|
"update_vet": {
|
|
"name": "update_vet",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.update_vet",
|
|
"signature": "update_vet(id: int, payload: VetCreate)",
|
|
"docstring": "Update an existing vet."
|
|
},
|
|
"delete_vet": {
|
|
"name": "delete_vet",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.delete_vet",
|
|
"signature": "delete_vet(id: int, response: Response)",
|
|
"docstring": "Delete an existing vet."
|
|
},
|
|
"list_treatments": {
|
|
"name": "list_treatments",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.list_treatments",
|
|
"signature": "list_treatments() -> list[Treatment]",
|
|
"docstring": "List treatments (catalogue).\n\nReturns\n-------\nlist[Treatment]\n A list of treatment domain objects."
|
|
},
|
|
"create_treatment": {
|
|
"name": "create_treatment",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.create_treatment",
|
|
"signature": "create_treatment(payload: TreatmentCreate, response: Response)",
|
|
"docstring": "Add a treatment (admin only)."
|
|
},
|
|
"get_treatment": {
|
|
"name": "get_treatment",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.get_treatment",
|
|
"signature": "get_treatment(id: int)",
|
|
"docstring": "Retrieve a single treatment by ID."
|
|
},
|
|
"update_treatment": {
|
|
"name": "update_treatment",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.update_treatment",
|
|
"signature": "update_treatment(id: int, payload: TreatmentCreate)",
|
|
"docstring": "Update an existing treatment."
|
|
},
|
|
"delete_treatment": {
|
|
"name": "delete_treatment",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.delete_treatment",
|
|
"signature": "delete_treatment(id: int, response: Response)",
|
|
"docstring": "Delete an existing treatment."
|
|
},
|
|
"list_pets": {
|
|
"name": "list_pets",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.list_pets",
|
|
"signature": "list_pets(limit: int = 20, offset: int = 0)",
|
|
"docstring": "List pets (paginated)."
|
|
},
|
|
"create_pet": {
|
|
"name": "create_pet",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.create_pet",
|
|
"signature": "create_pet(payload: PetCreate, response: Response)",
|
|
"docstring": "Create a pet."
|
|
},
|
|
"get_pet": {
|
|
"name": "get_pet",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.get_pet",
|
|
"signature": "get_pet(id: int)",
|
|
"docstring": "Retrieve a single pet by ID."
|
|
},
|
|
"update_pet": {
|
|
"name": "update_pet",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.update_pet",
|
|
"signature": "update_pet(id: int, payload: PetCreate)",
|
|
"docstring": "Update an existing pet."
|
|
},
|
|
"delete_pet": {
|
|
"name": "delete_pet",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.delete_pet",
|
|
"signature": "delete_pet(id: int, response: Response)",
|
|
"docstring": "Delete an existing pet."
|
|
},
|
|
"upload_pet_photo": {
|
|
"name": "upload_pet_photo",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.upload_pet_photo",
|
|
"signature": "upload_pet_photo(id: int, file: UploadFile) -> dict",
|
|
"docstring": "Upload a pet photo.\n\nParameters\n----------\nid : int\n Identifier of the pet.\nfile : UploadFile\n Image file to upload.\n\nReturns\n-------\ndict\n A confirmation with the pet ID."
|
|
},
|
|
"list_appointments": {
|
|
"name": "list_appointments",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.list_appointments",
|
|
"signature": "list_appointments(limit: int = 20, offset: int = 0, date: str = None, vet: int = None, pet: int = None)",
|
|
"docstring": "List appointments (paginated, filterable)."
|
|
},
|
|
"create_appointment": {
|
|
"name": "create_appointment",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.create_appointment",
|
|
"signature": "create_appointment(payload: AppointmentCreate, response: Response)",
|
|
"docstring": "Create an appointment."
|
|
},
|
|
"get_appointment": {
|
|
"name": "get_appointment",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.get_appointment",
|
|
"signature": "get_appointment(id: int)",
|
|
"docstring": "Retrieve a single appointment by ID."
|
|
},
|
|
"update_appointment": {
|
|
"name": "update_appointment",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.update_appointment",
|
|
"signature": "update_appointment(id: int, payload: AppointmentCreate)",
|
|
"docstring": "Update an existing appointment."
|
|
},
|
|
"delete_appointment": {
|
|
"name": "delete_appointment",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.delete_appointment",
|
|
"signature": "delete_appointment(id: int, response: Response)",
|
|
"docstring": "Delete an existing appointment."
|
|
},
|
|
"stream_actions": {
|
|
"name": "stream_actions",
|
|
"kind": "function",
|
|
"path": "openapi_first.templates.vet_app.routes.stream_actions",
|
|
"signature": "stream_actions(id: int)",
|
|
"docstring": "Stream animal actions via SSE, scoped to a pet's species."
|
|
}
|
|
}
|
|
}
|
|
} |