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

docs: Health check endpoint (#3959)

Browse Source 
### What
Adds documentation for the health check endpoint.

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
This commit is contained in:
Christopher Kolstad 2023-06-12 14:56:45 +02:00 committed by GitHub
parent d410f4774c
commit 7003351b35
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/lib/openapi/meta-schema-rules.test.ts
View File

@ -112,7 +112,6 @@ const metaRules: Rule[] = [
'groupSchema',
'groupsSchema',
'groupUserModelSchema',
'healthCheckSchema',
'idSchema',
'instanceAdminStatsSchema',
'legalValueSchema',
@ -217,7 +216,6 @@ const metaRules: Rule[] = [
'groupSchema',
'groupsSchema',
'groupUserModelSchema',
'healthCheckSchema',
'idSchema',
'instanceAdminStatsSchema',
'legalValueSchema',

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

@ -3,12 +3,17 @@ import { FromSchema } from 'json-schema-to-ts';
export const healthCheckSchema = {
$id: '#/components/schemas/healthCheckSchema',
type: 'object',
description:
'Used by service orchestrators to decide whether this Unleash instance should be marked as healthy or unhealthy',
additionalProperties: false,
required: ['health'],
properties: {
health: {
description:
'The state this Unleash instance is in. GOOD if everything is ok, BAD if the instance should be restarted',
type: 'string',
enum: ['GOOD', 'BAD'],
example: 'GOOD',
},
},
components: {},

3
src/lib/routes/health-check.ts
View File

@ -31,6 +31,9 @@ export class HealthCheckController extends Controller {
openApiService.validPath({
tags: ['Operational'],
operationId: 'getHealth',
summary: 'Get instance operational status',
description:
'This operation returns information about whether this Unleash instance is healthy and ready to serve requests or not. Typically used by your deployment orchestrator (e.g. Kubernetes, Docker Swarm, Mesos, et al.).',
responses: {
200: createResponseSchema('healthCheckSchema'),
500: createResponseSchema('healthCheckSchema'),

5
src/test/e2e/api/openapi/__snapshots__/openapi.e2e.test.ts.snap
View File

@ -2737,12 +2737,15 @@ The provider you choose for your addon dictates what properties the \`parameters
},
"healthCheckSchema": {
"additionalProperties": false,
"description": "Used by service orchestrators to decide whether this Unleash instance should be marked as healthy or unhealthy",
"properties": {
"health": {
"description": "The state this Unleash instance is in. GOOD if everything is ok, BAD if the instance should be restarted",
"enum": [
"GOOD",
"BAD",
],
"example": "GOOD",
"type": "string",
},
},
@ -13726,6 +13729,7 @@ If the provided project does not exist, the list of events will be empty.",
},
"/health": {
"get": {
"description": "This operation returns information about whether this Unleash instance is healthy and ready to serve requests or not. Typically used by your deployment orchestrator (e.g. Kubernetes, Docker Swarm, Mesos, et al.).",
"operationId": "getHealth",
"responses": {
"200": {
@ -13749,6 +13753,7 @@ If the provided project does not exist, the list of events will be empty.",
"description": "healthCheckSchema",
},
},
"summary": "Get instance operational status",
"tags": [
"Operational",
],