Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-10-27 11:02:16 +01:00
Code Issues Projects Releases Wiki Activity

docs: explain health API properly (#10009)

Browse Source 
## About the changes
Our health implementation always returns GOOD if the server is up:
beb29f5b5b/src/lib/routes/health-check.ts (L46-L51)

Currently our documentation of the endpoint is misleading saying that it
will return BAD if unable to connect to PostgreSQL

Closes #9965
This commit is contained in:
Gastón Fournier 2025-05-16 12:38:27 +02:00 committed by GitHub
parent b133bb842b
commit e754212a39
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 3 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/lib/openapi/spec/health-check-schema.ts
View File

@ -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',

10
website/docs/reference/api/legacy/unleash/internal/health.md
View File

@ -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.