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

add pages.getPageTag API reference

Ryu Sato 6 лет назад
Родитель
Сommit
598e9f2842
1 измененных файлов с 33 добавлено и 0 удалено
  1. 33 0
      src/server/routes/page.js

+ 33 - 0
src/server/routes/page.js

@@ -1109,6 +1109,39 @@ module.exports = function(crowi, app) {
     return res.json(ApiResponse.success(result));
   };
 
+  /**
+   * @swagger
+   *
+   *    /_api/pages.getPageTag:
+   *      get:
+   *        tags: [Pages]
+   *        operationId: getPageTag
+   *        summary: /_api/pages.getPageTag
+   *        description: Get page tag
+   *        parameters:
+   *          - in: query
+   *            name: pageId
+   *            schema:
+   *              $ref: '#/components/schemas/Page/properties/_id'
+   *        responses:
+   *          200:
+   *            description: Succeeded to get page tags.
+   *            content:
+   *              application/json:
+   *                schema:
+   *                  properties:
+   *                    ok:
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
+   *                    tags:
+   *                      type: array
+   *                      description: Tag names
+   *                      items: string
+   *                      example: ['daily', 'report', 'tips']
+   *          403:
+   *            $ref: '#/components/responses/403'
+   *          500:
+   *            $ref: '#/components/responses/500'
+   */
   /**
    * @api {get} /pages.getPageTag get page tags
    * @apiName GetPageTag