mirror of
https://github.com/Unleash/unleash.git
synced 2025-02-04 00:18:01 +01:00
7003351b35
### What Adds documentation for the health check endpoint. --------- Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
23 lines
751 B
TypeScript
23 lines
751 B
TypeScript
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: {},
|
|
} as const;
|
|
|
|
export type HealthCheckSchema = FromSchema<typeof healthCheckSchema>;
|