Просмотр исходного кода

support(jsdoc): Update response format and tag

Atsushi Nakatsugawa 1 год назад
Родитель
Сommit
de21e99330
1 измененных файлов с 3 добавлено и 6 удалено
  1. 3 6
      apps/app/src/server/routes/apiv3/healthcheck.ts

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

@@ -76,7 +76,7 @@ module.exports = (crowi) => {
    *
    *  /healthcheck:
    *    get:
-   *      tags: [SecuritySetting]
+   *      tags: [Healthcheck]
    *      security: []
    *      operationId: getHealthcheck
    *      summary: /healthcheck
@@ -104,9 +104,8 @@ module.exports = (crowi) => {
    *            application/json:
    *              schema:
    *                properties:
-   *                  status:
-   *                    type: string
-   *                    description: Status
+   *                  info:
+   *                    $ref: '#/components/schemas/HealthcheckInfo'
    *        503:
    *          description: Unhealthy
    *          content:
@@ -118,8 +117,6 @@ module.exports = (crowi) => {
    *                    description: Errors
    *                    items:
    *                      $ref: '#/components/schemas/ErrorV3'
-   *                  info:
-   *                    $ref: '#/components/schemas/HealthcheckInfo'
    */
   router.get('/', nocache(), async(req, res: ApiV3Response) => {
     let checkServices = (() => {