MANSOQ Knowledge
← Technical API reference

Backend resource · STATIC DECLARATIONS

Middleware Health API reference · mansoq-teleicu-gateway

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.

Static API contract — behavior review pending. Source baseline f6e9f05f76d4.

Enable JavaScript to inspect structured operation, parameter, schema and permission evidence. Download this reference and its evidence.

Declared route and availability

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.

Operation map

Method Path Action Evidence
GET /api/{installed_plugin_prefix}/health/ping ping @action declaration
GET /api/{installed_plugin_prefix}/health/status health_check @action declaration
GET /api/{installed_plugin_prefix}/health/care/communication mansoq_communication_check @action declaration
GET /api/{installed_plugin_prefix}/health/care/communication-asset mansoq_communication_check_as_asset @action declaration

ping · GET

GET /api/{installed_plugin_prefix}/health/ping — action ping. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
deployment mount installed_plugin_prefix deployment-selected mount prefix true

decorator responses: PingResponse. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
pong datetime true No extra constraint extracted

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.

Explicit response statuses in observed code: status.HTTP_200_OK. Other branches/framework exception handling may differ.

health_check · GET

GET /api/{installed_plugin_prefix}/health/status — action health_check. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
deployment mount installed_plugin_prefix deployment-selected mount prefix true

decorator responses: HealthCheckResponse. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
server bool true No extra constraint extracted
database bool true No extra constraint extracted

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.

Explicit response statuses in observed code: status_code. Other branches/framework exception handling may differ.

mansoq_communication_check · GET

GET /api/{installed_plugin_prefix}/health/care/communication — action mansoq_communication_check. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
deployment mount installed_plugin_prefix deployment-selected mount prefix true

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.

Explicit response statuses in observed code: 500. Other branches/framework exception handling may differ.

mansoq_communication_check_as_asset · GET

GET /api/{installed_plugin_prefix}/health/care/communication-asset — action mansoq_communication_check_as_asset. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
deployment mount installed_plugin_prefix deployment-selected mount prefix true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
query ip not declared at read site not established
query ext_id not declared at read site not established

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.

Explicit response statuses in observed code: 404, 500. Other branches/framework exception handling may differ.

Integration review checklist

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.

Pinned source evidence

Links require access to the private source repository.