diff --git a/src/lib/openapi/spec/health-check-schema.ts b/src/lib/openapi/spec/health-check-schema.ts index 81612d4e14..e7f6dbbdb1 100644 --- a/src/lib/openapi/spec/health-check-schema.ts +++ b/src/lib/openapi/spec/health-check-schema.ts @@ -10,7 +10,7 @@ export const healthCheckSchema = { properties: { health: { description: - 'The state this Unleash instance is in. GOOD if everything is ok, BAD if the instance should be restarted', + 'The state this Unleash instance is in. GOOD if the server is up and running. It never returns BAD, if the server is unhealthy you will get an unsuccessful http response.', type: 'string', enum: ['GOOD', 'BAD'], example: 'GOOD', diff --git a/website/docs/reference/api/legacy/unleash/internal/health.md b/website/docs/reference/api/legacy/unleash/internal/health.md index 8711da6042..1cbe3409ec 100644 --- a/website/docs/reference/api/legacy/unleash/internal/health.md +++ b/website/docs/reference/api/legacy/unleash/internal/health.md @@ -16,14 +16,8 @@ Used to check the health of the running Unleash instance. This endpoint has two } ``` -This response means everything is OK. Unleash is able to talk to the PostgreSQL +This response means Unleash server is up. `Status: 500` -```json -{ - "health": "BAD" -} -``` - -This response indicates that Unleash is not able to talk to PostgreSQL and will not be able to serve requests. +This response indicates that Unleash server is unhealthy.