hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-14 08:02:15 +03:00
Code Issues Projects Releases Wiki Activity

docs: document the strict parameter in healthz API reference

Browse Source 
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8693
GitOrigin-RevId: 9201279658a474da7624ab439345ef62fbc56fc4
This commit is contained in:
Rakesh Emmadi 2023-04-10 17:14:21 +05:30 committed by hasura-bot
parent 33bea64ed1
commit b18c86c7f7
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/docs/api-reference/health.mdx
View File

@ -27,19 +27,27 @@ completely.
### Request
```http
GET /healthz HTTP/1.1
GET /healthz?strict=false HTTP/1.1
```
#### Parameters
| Name | Required | type | Description |
|--------|----------|---------|-------------------------------------------------------------------------------------------|
| strict | false | boolean | If set to `true`, response returns `500` if inconsistent objects exist (default: `false`) |
### Response
Depending on the server health status any of the following responses can
be returned:
| Server condition | HTTP Status | Message |
| ------------------------------------------------------------------------- | ----------- | ------------------------------------ |
| All healthy | 200 | OK |
| Serving requests but some Metadata objects are inconsistent/not-available | 200 | WARN: inconsistent objects in schema |
| Unhealthy | 500 | ERROR |
| Server condition | `strict` parameter | HTTP Status | Message |
|---------------------------------------------------------------------------|--------------------|-------------|---------------------------------------|
| All healthy | Any | 200 | OK |
| Serving requests but some Metadata objects are inconsistent/not-available | `false` | 200 | WARN: inconsistent objects in schema |
| Serving requests but some Metadata objects are inconsistent/not-available | `true` | 500 | ERROR: inconsistent objects in schema |
| Unhealthy | Any | 500 | ERROR |
:::info Note