{"schemaVersion":"1.0","sourceCommit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca","sourceVisibility":"private","article":{"id":"api-mansoq-teleicu-gateway-middlewarehealthviewset-9edffde4","title":"Middleware Health API reference · mansoq-teleicu-gateway","summary":"Static source contract for Middleware Health: 4 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.","module":"IT & integrations","roles":["IT administrator","Developer","Integration engineer"],"facilities":["All configured facility types"],"kind":"reference","minutes":4,"prerequisites":["Use the API contract from the installed deployment and an authorized synthetic test environment.","Confirm facility/organization scope, action permissions and optional app enablement.","This reference is static source evidence; complete payload, authorization, failure and end-to-end review remains recorded as pending."],"steps":[],"sections":[{"title":"Declared route and availability","body":"This resource is declared in **mansoq-teleicu-gateway** at `/api/{installed_plugin_prefix}/health`. plugin/local mount; actual prefix and enablement require deployment verification A registered path and an indexed handler do not prove deployment availability, user permission or production readiness."},{"title":"Operation map","body":"| Method | Path | Action | Evidence |\n| --- | --- | --- | --- |\n| GET | `/api/{installed_plugin_prefix}/health/ping` | ping | @action declaration |\n| GET | `/api/{installed_plugin_prefix}/health/status` | health_check | @action declaration |\n| GET | `/api/{installed_plugin_prefix}/health/care/communication` | mansoq_communication_check | @action declaration |\n| GET | `/api/{installed_plugin_prefix}/health/care/communication-asset` | mansoq_communication_check_as_asset | @action declaration |"},{"title":"ping · GET","body":"**GET /api/{installed_plugin_prefix}/health/ping** — action `ping`. static contract extracted; runtime/permission/payload behavior review pending.\n\nPath and deployment-context parameters:\n\n| Location | Parameter | Type | Required |\n| --- | --- | --- | --- |\n| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |\n\n**decorator responses: PingResponse**. Declared fields below; inherited fields are retained in the schema inventory.\n\n| Field | Type | Required | Constraints |\n| --- | --- | --- | --- |\n| pong | datetime | true | No extra constraint extracted |\n\n**Authorization:** no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.\n\n**Explicit response statuses in observed code:** status.HTTP_200_OK. Other branches/framework exception handling may differ."},{"title":"health_check · GET","body":"**GET /api/{installed_plugin_prefix}/health/status** — action `health_check`. static contract extracted; runtime/permission/payload behavior review pending.\n\nPath and deployment-context parameters:\n\n| Location | Parameter | Type | Required |\n| --- | --- | --- | --- |\n| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |\n\n**decorator responses: HealthCheckResponse**. Declared fields below; inherited fields are retained in the schema inventory.\n\n| Field | Type | Required | Constraints |\n| --- | --- | --- | --- |\n| server | bool | true | No extra constraint extracted |\n| database | bool | true | No extra constraint extracted |\n\n**Authorization:** no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.\n\n**Explicit response statuses in observed code:** status_code. Other branches/framework exception handling may differ."},{"title":"mansoq_communication_check · GET","body":"**GET /api/{installed_plugin_prefix}/health/care/communication** — action `mansoq_communication_check`. static contract extracted; runtime/permission/payload behavior review pending.\n\nPath and deployment-context parameters:\n\n| Location | Parameter | Type | Required |\n| --- | --- | --- | --- |\n| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |\n\n**Authorization:** no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.\n\n**Explicit response statuses in observed code:** 500. Other branches/framework exception handling may differ."},{"title":"mansoq_communication_check_as_asset · GET","body":"**GET /api/{installed_plugin_prefix}/health/care/communication-asset** — action `mansoq_communication_check_as_asset`. static contract extracted; runtime/permission/payload behavior review pending.\n\nPath and deployment-context parameters:\n\n| Location | Parameter | Type | Required |\n| --- | --- | --- | --- |\n| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |\n\nDirectly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):\n\n| Location | Field | Declared/inferred read type | Requiredness evidence |\n| --- | --- | --- | --- |\n| query | `ip` | not declared at read site | not established |\n| query | `ext_id` | not declared at read site | not established |\n\n**Authorization:** no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.\n\n**Explicit response statuses in observed code:** 404, 500. Other branches/framework exception handling may differ."},{"title":"Integration review checklist","body":"Confirm the installed route and full schema; review authentication, organization/facility scoping, all accepted fields, value-state and date/time semantics, idempotency, pagination, response/exception branches and the allowed correction/reversal workflow. Test positive and negative cases with synthetic data. This source reference does not establish external certification or replace an illustrated user procedure."}],"troubleshooting":[{"problem":"A declared route is unavailable or a request is rejected","solution":"Compare the installed revision, actual API schema, optional plugin mount, HTTP-method restrictions and recorded validation/permission evidence. Do not bypass a refusal or send a production transaction to test documentation."}],"sources":[{"path":"repositories/teleicu/mansoq-teleicu-gateway/core/urls.py","line":28,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":34,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":39,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/types.py","line":19,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":46,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/types.py","line":23,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":65,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":83,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}],"related":["it-api-contract","it-api-auth","security-rcm-roles"],"verification":"Static API contract — behavior review pending","version":"f6e9f05f76d4","apiReferenceIds":["backend-resource-24b951a59edffde4","backend-resource-24b951a59edffde4:GET:ping","backend-resource-24b951a59edffde4:GET:health_check","backend-resource-24b951a59edffde4:GET:mansoq_communication_check","backend-resource-24b951a59edffde4:GET:mansoq_communication_check_as_asset"]},"backend":{"resources":[{"id":"backend-resource-24b951a59edffde4","localPrefix":"health","viewset":"MiddlewareHealthViewSet","classId":"repositories/teleicu/mansoq-teleicu-gateway:middleware.views.MiddlewareHealthViewSet","basename":"health","source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/core/urls.py","line":28,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"conditions":[],"repository":"repositories/teleicu/mansoq-teleicu-gateway","classSource":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":34,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"description":"","path":"/api/{installed_plugin_prefix}/health","mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","operationIds":["backend-resource-24b951a59edffde4:GET:ping","backend-resource-24b951a59edffde4:GET:health_check","backend-resource-24b951a59edffde4:GET:mansoq_communication_check","backend-resource-24b951a59edffde4:GET:mansoq_communication_check_as_asset"],"unresolvedViewset":false,"reviewStatus":"registered resource enumerated; behavioral review pending"}],"operations":[{"id":"backend-resource-24b951a59edffde4:GET:ping","resourceId":"backend-resource-24b951a59edffde4","repository":"repositories/teleicu/mansoq-teleicu-gateway","boundary":"optional-plugin/local-service","method":"GET","path":"/api/{installed_plugin_prefix}/health/ping","declaredPattern":"/api/{installed_plugin_prefix}/health/ping","action":"ping","viewset":"MiddlewareHealthViewSet","classId":"repositories/teleicu/mansoq-teleicu-gateway:middleware.views.MiddlewareHealthViewSet","detail":false,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-teleicu-gateway/core/urls.py","line":28,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":39,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"registrationConditions":[],"evidenceKind":"@action declaration","methodEvidenceIds":["repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py:39:ping"],"schemaIds":{"decorator responses":"repositories/teleicu/mansoq-teleicu-gateway:middleware.types.PingResponse"},"classPermissionEvidence":[],"filterEvidence":[],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[{"name":"installed_plugin_prefix","in":"deployment mount","type":"deployment-selected mount prefix","required":true,"source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/core/urls.py","line":28,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]},{"id":"backend-resource-24b951a59edffde4:GET:health_check","resourceId":"backend-resource-24b951a59edffde4","repository":"repositories/teleicu/mansoq-teleicu-gateway","boundary":"optional-plugin/local-service","method":"GET","path":"/api/{installed_plugin_prefix}/health/status","declaredPattern":"/api/{installed_plugin_prefix}/health/status","action":"health_check","viewset":"MiddlewareHealthViewSet","classId":"repositories/teleicu/mansoq-teleicu-gateway:middleware.views.MiddlewareHealthViewSet","detail":false,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-teleicu-gateway/core/urls.py","line":28,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":46,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"registrationConditions":[],"evidenceKind":"@action declaration","methodEvidenceIds":["repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py:46:health_check"],"schemaIds":{"decorator responses":"repositories/teleicu/mansoq-teleicu-gateway:middleware.types.HealthCheckResponse"},"classPermissionEvidence":[],"filterEvidence":[],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[{"name":"installed_plugin_prefix","in":"deployment mount","type":"deployment-selected mount prefix","required":true,"source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/core/urls.py","line":28,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]},{"id":"backend-resource-24b951a59edffde4:GET:mansoq_communication_check","resourceId":"backend-resource-24b951a59edffde4","repository":"repositories/teleicu/mansoq-teleicu-gateway","boundary":"optional-plugin/local-service","method":"GET","path":"/api/{installed_plugin_prefix}/health/care/communication","declaredPattern":"/api/{installed_plugin_prefix}/health/care/communication","action":"mansoq_communication_check","viewset":"MiddlewareHealthViewSet","classId":"repositories/teleicu/mansoq-teleicu-gateway:middleware.views.MiddlewareHealthViewSet","detail":false,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-teleicu-gateway/core/urls.py","line":28,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":65,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"registrationConditions":[],"evidenceKind":"@action declaration","methodEvidenceIds":["repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py:65:mansoq_communication_check"],"schemaIds":{},"classPermissionEvidence":[],"filterEvidence":[],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[{"name":"installed_plugin_prefix","in":"deployment mount","type":"deployment-selected mount prefix","required":true,"source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/core/urls.py","line":28,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]},{"id":"backend-resource-24b951a59edffde4:GET:mansoq_communication_check_as_asset","resourceId":"backend-resource-24b951a59edffde4","repository":"repositories/teleicu/mansoq-teleicu-gateway","boundary":"optional-plugin/local-service","method":"GET","path":"/api/{installed_plugin_prefix}/health/care/communication-asset","declaredPattern":"/api/{installed_plugin_prefix}/health/care/communication-asset","action":"mansoq_communication_check_as_asset","viewset":"MiddlewareHealthViewSet","classId":"repositories/teleicu/mansoq-teleicu-gateway:middleware.views.MiddlewareHealthViewSet","detail":false,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-teleicu-gateway/core/urls.py","line":28,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":83,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"registrationConditions":[],"evidenceKind":"@action declaration","methodEvidenceIds":["repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py:83:mansoq_communication_check_as_asset"],"schemaIds":{},"classPermissionEvidence":[],"filterEvidence":[],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[{"name":"installed_plugin_prefix","in":"deployment mount","type":"deployment-selected mount prefix","required":true,"source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/core/urls.py","line":28,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]}],"methodEvidence":[{"id":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py:39:ping","name":"ping","owner":"repositories/teleicu/mansoq-teleicu-gateway:middleware.views.MiddlewareHealthViewSet","summary":"","source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":39,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[],"permissionChecks":[],"declaredErrors":[],"explicitResponseStatuses":[{"value":null,"symbol":"status.HTTP_200_OK","source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":40,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"conditions":[],"schemaIds":["repositories/teleicu/mansoq-teleicu-gateway:middleware.types.PingResponse"],"schemaUsages":[{"purpose":"decorator responses","schemaId":"repositories/teleicu/mansoq-teleicu-gateway:middleware.types.PingResponse","source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":35,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"},{"id":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py:46:health_check","name":"health_check","owner":"repositories/teleicu/mansoq-teleicu-gateway:middleware.views.MiddlewareHealthViewSet","summary":"","source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":46,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[],"permissionChecks":[],"declaredErrors":[],"explicitResponseStatuses":[{"value":null,"symbol":"status_code","source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":59,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"conditions":[],"schemaIds":["repositories/teleicu/mansoq-teleicu-gateway:middleware.types.HealthCheckResponse"],"schemaUsages":[{"purpose":"decorator responses","schemaId":"repositories/teleicu/mansoq-teleicu-gateway:middleware.types.HealthCheckResponse","source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":42,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"},{"id":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py:65:mansoq_communication_check","name":"mansoq_communication_check","owner":"repositories/teleicu/mansoq-teleicu-gateway:middleware.views.MiddlewareHealthViewSet","summary":"","source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":65,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[],"permissionChecks":[],"declaredErrors":[],"explicitResponseStatuses":[{"value":500,"symbol":null,"source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":74,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"},{"id":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py:83:mansoq_communication_check_as_asset","name":"mansoq_communication_check_as_asset","owner":"repositories/teleicu/mansoq-teleicu-gateway:middleware.views.MiddlewareHealthViewSet","summary":"","source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":83,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[{"name":"ip","in":"query","type":"not declared at read site","required":"not established","readStyle":"get","dynamicName":false,"source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":84,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"ext_id","in":"query","type":"not declared at read site","required":"not established","readStyle":"get","dynamicName":false,"source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":85,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"permissionChecks":[],"declaredErrors":[],"explicitResponseStatuses":[{"value":404,"symbol":null,"source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":96,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"value":500,"symbol":null,"source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/views.py","line":106,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"}],"schemas":[{"id":"repositories/teleicu/mansoq-teleicu-gateway:middleware.types.PingResponse","name":"PingResponse","source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/types.py","line":19,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"kind":"Python declared schema/model evidence","fields":[{"name":"pong","type":"datetime","required":true,"hasDefault":false,"source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/types.py","line":20,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}}],"validation":[],"baseTypes":["BaseModel"],"reviewStatus":"declared fields extracted; runtime validation review pending","referencedSchemaIds":[]},{"id":"repositories/teleicu/mansoq-teleicu-gateway:middleware.types.HealthCheckResponse","name":"HealthCheckResponse","source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/types.py","line":23,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"kind":"Python declared schema/model evidence","fields":[{"name":"server","type":"bool","required":true,"hasDefault":false,"source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/types.py","line":24,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"database","type":"bool","required":true,"hasDefault":false,"source":{"path":"repositories/teleicu/mansoq-teleicu-gateway/middleware/types.py","line":25,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}}],"validation":[],"baseTypes":["BaseModel"],"reviewStatus":"declared fields extracted; runtime validation review pending","referencedSchemaIds":[]}],"frameworkSettings":[]},"frontend":{"operations":[],"schemas":[]},"services":{"operations":[]},"boundaries":[]}