Explorar el Código

support(jsdoc): Fix/doc v3 healthcheck

Atsushi Nakatsugawa hace 1 año
padre
commit
5073f289d8
Se han modificado 1 ficheros con 5 adiciones y 3 borrados
  1. 5 3
      apps/app/src/server/routes/apiv3/healthcheck.ts

+ 5 - 3
apps/app/src/server/routes/apiv3/healthcheck.ts

@@ -76,7 +76,8 @@ module.exports = (crowi) => {
    *
    *
    *  /healthcheck:
    *  /healthcheck:
    *    get:
    *    get:
-   *      tags: [Healthcheck]
+   *      tags: [SecuritySetting]
+   *      security: []
    *      operationId: getHealthcheck
    *      operationId: getHealthcheck
    *      summary: /healthcheck
    *      summary: /healthcheck
    *      description: Check whether the server is healthy or not
    *      description: Check whether the server is healthy or not
@@ -103,8 +104,9 @@ module.exports = (crowi) => {
    *            application/json:
    *            application/json:
    *              schema:
    *              schema:
    *                properties:
    *                properties:
-   *                  info:
-   *                    $ref: '#/components/schemas/HealthcheckInfo'
+   *                  status:
+   *                    type: string
+   *                    description: Status
    *        503:
    *        503:
    *          description: Unhealthy
    *          description: Unhealthy
    *          content:
    *          content: