From f4c17f35bccd5e0bb7ac5a68ab012ae7e1d98d73 Mon Sep 17 00:00:00 2001 From: Atsushi Nakatsugawa Date: Thu, 19 Dec 2024 14:37:55 +0900 Subject: [PATCH 1/2] support(jsdoc): add swagger document to healthcheck.ts --- apps/app/src/server/routes/apiv3/healthcheck.ts | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/apps/app/src/server/routes/apiv3/healthcheck.ts b/apps/app/src/server/routes/apiv3/healthcheck.ts index 9a2d4989fcd..645c179adc5 100644 --- a/apps/app/src/server/routes/apiv3/healthcheck.ts +++ b/apps/app/src/server/routes/apiv3/healthcheck.ts @@ -77,6 +77,7 @@ module.exports = (crowi) => { * /healthcheck: * get: * tags: [Healthcheck] + * security: [] * operationId: getHealthcheck * summary: /healthcheck * description: Check whether the server is healthy or not @@ -96,6 +97,9 @@ module.exports = (crowi) => { * description: Check services and responds 503 if either of these is unhealthy * schema: * type: boolean + * - name: connectToMiddlewares + * in: query + * description: 'Deprecated. Use \'checkServices[]\' instead.' * responses: * 200: * description: Healthy @@ -103,8 +107,9 @@ module.exports = (crowi) => { * application/json: * schema: * properties: - * info: - * $ref: '#/components/schemas/HealthcheckInfo' + * status: + * type: string + * description: Status * 503: * description: Unhealthy * content: From 850e3da6edd530609eb46549fb42ae5ac0b1b89a Mon Sep 17 00:00:00 2001 From: Atsushi Nakatsugawa Date: Thu, 19 Dec 2024 14:43:12 +0900 Subject: [PATCH 2/2] support(jsdoc): add swagger document to healthcheck.ts --- apps/app/src/server/routes/apiv3/healthcheck.ts | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/apps/app/src/server/routes/apiv3/healthcheck.ts b/apps/app/src/server/routes/apiv3/healthcheck.ts index 645c179adc5..b0f204bb049 100644 --- a/apps/app/src/server/routes/apiv3/healthcheck.ts +++ b/apps/app/src/server/routes/apiv3/healthcheck.ts @@ -76,7 +76,7 @@ module.exports = (crowi) => { * * /healthcheck: * get: - * tags: [Healthcheck] + * tags: [SecuritySetting] * security: [] * operationId: getHealthcheck * summary: /healthcheck @@ -97,9 +97,6 @@ module.exports = (crowi) => { * description: Check services and responds 503 if either of these is unhealthy * schema: * type: boolean - * - name: connectToMiddlewares - * in: query - * description: 'Deprecated. Use \'checkServices[]\' instead.' * responses: * 200: * description: Healthy