Răsfoiți Sursa

add pages.exist API reference

Ryu Sato 6 ani în urmă
părinte
comite
4cdc45cfae
1 a modificat fișierele cu 34 adăugiri și 0 ștergeri
  1. 34 0
      src/server/routes/page.js

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

@@ -1052,6 +1052,40 @@ module.exports = function(crowi, app) {
     return res.json(ApiResponse.success(result));
   };
 
+  /**
+   * @swagger
+   *
+   *    /_api/pages.exist:
+   *      get:
+   *        tags: [Pages]
+   *        operationId: getPageExistence
+   *        summary: /_api/pages.exist
+   *        description: Get page existence
+   *        parameters:
+   *          - in: query
+   *            name: pages
+   *            schema:
+   *              type: string
+   *              description: Page paths specified by hash key in JSON format
+   *              example: '{"/": "unused value", "/user/unknown": "unused value"}'
+   *        responses:
+   *          200:
+   *            description: Succeeded to get page data.
+   *            content:
+   *              application/json:
+   *                schema:
+   *                  properties:
+   *                    ok:
+   *                      $ref: '#/components/schemas/V1Response/properties/ok'
+   *                    pages:
+   *                      type: Object
+   *                      description: Properties of page path and existence
+   *                      example: {"/": true, "/user/unknown": false}
+   *          403:
+   *            $ref: '#/components/responses/403'
+   *          500:
+   *            $ref: '#/components/responses/500'
+   */
   /**
    * @api {get} /pages.exist Get if page exists
    * @apiName GetPage