mirror of
https://github.com/Unleash/unleash.git
synced 2024-10-18 20:09:08 +02:00
9448461aaa
* Docs: start experimenting with OpenAPI and docusaurus * Docs: add docusaurus-theme-openapi-docs pkg * Wip: current status * Docs: Add 'docusaurus-plugin-api-docs' * Move openapi into own sidebar; generate from localhost * Chore: Update docusaurus plugin for OpenAPI * Add website/yarn.lock to git * Fix: fix CSS warning by using flex-end instead of end * docs: make openapi generated code work again * docs: make tags work properly with openapi sidebar * Docs/chore: update OpenAPI tag scheme. Add a whole bunch of new tags to make it easier to understand available tags in OpenAPI. * docs: point to new openapi docs from old api docs * docs: typo * Docs: link restructure * docs: add operation indicators to openapi docs * docs: change badge color for operations * docs: update openapi-docs package It now sorts tags the same as the schema * docs: pluralize APIs in slug * docs: update links to generated api docs * docs: update openapi snapshot tests with new tags * docs: conditionally load spec from localhost or from file * docs: Remove changes relating to immediate switchover * refactor: rename types; extract into separate file * docs: fix api doc links
50 lines
1.5 KiB
TypeScript
50 lines
1.5 KiB
TypeScript
import { Request, Response } from 'express';
|
|
import { IUnleashConfig } from '../types/option';
|
|
import { IUnleashServices } from '../types/services';
|
|
import { Logger } from '../logger';
|
|
import { OpenApiService } from '../services/openapi-service';
|
|
|
|
import Controller from './controller';
|
|
import { NONE } from '../types/permissions';
|
|
import { createResponseSchema } from '../openapi/util/create-response-schema';
|
|
import { HealthCheckSchema } from '../openapi/spec/health-check-schema';
|
|
|
|
export class HealthCheckController extends Controller {
|
|
private logger: Logger;
|
|
|
|
private openApiService: OpenApiService;
|
|
|
|
constructor(
|
|
config: IUnleashConfig,
|
|
{ openApiService }: Pick<IUnleashServices, 'openApiService'>,
|
|
) {
|
|
super(config);
|
|
this.logger = config.getLogger('health-check.js');
|
|
this.openApiService = openApiService;
|
|
|
|
this.route({
|
|
method: 'get',
|
|
path: '',
|
|
handler: this.getHealth,
|
|
permission: NONE,
|
|
middleware: [
|
|
openApiService.validPath({
|
|
tags: ['Operational'],
|
|
operationId: 'getHealth',
|
|
responses: {
|
|
200: createResponseSchema('healthCheckSchema'),
|
|
500: createResponseSchema('healthCheckSchema'),
|
|
},
|
|
}),
|
|
],
|
|
});
|
|
}
|
|
|
|
async getHealth(
|
|
_: Request,
|
|
res: Response<HealthCheckSchema>,
|
|
): Promise<void> {
|
|
res.status(200).json({ health: 'GOOD' });
|
|
}
|
|
}
|