Health
Check the service is up
Always answers 200 with the package version and the diagram kinds this build renders.
GET
/healthTL;DR
| Question | Answer |
|---|---|
| What does it do? | Check the service is up. |
| What does it take? | Nothing. |
| What does it return? | Status 200 with a body of type HealthResponse. |
| What can go wrong? | Nothing beyond a server error. |
What it does
Always answers 200 with the package version and the diagram kinds this build renders.
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | Service is up. | HealthResponse |
Response body
A 200 answer has the type HealthResponse.
| Field | Type | Required | Description |
|---|---|---|---|
status | "ok" | yes | |
version | string | yes | Package version of the running service. |
kinds | string[] | yes | Diagram kinds this build can render. |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |