Selaa lähdekoodia

writte swagger

itizawa 6 vuotta sitten
vanhempi
sitoutus
409648a64a
1 muutettua tiedostoa jossa 26 lisäystä ja 1 poistoa
  1. 26 1
      src/server/routes/apiv3/users.js

+ 26 - 1
src/server/routes/apiv3/users.js

@@ -119,7 +119,32 @@ module.exports = (crowi) => {
       return res.apiv3Err(new ErrorV3(err));
     }
   });
-  // TODO writte swagger
+  /**
+   * @swagger
+   *
+   *  paths:
+   *    /_api/v3/users/{id}/activate:
+   *      put:
+   *        tags: [Users]
+   *        description: Activate user
+   *        parameters:
+   *          - name: id
+   *            in: path
+   *            required: true
+   *            description: id of activate user
+   *            schema:
+   *              type: string
+   *        responses:
+   *          200:
+   *            description: Activationg user success
+   *            content:
+   *              application/json:
+   *                schema:
+   *                  properties:
+   *                    userData:
+   *                      type: object
+   *                      description: data of activate user
+   */
   router.put('/:id/activate', loginRequiredStrictly, adminRequired, csrf, async(req, res) => {
     // check user upper limit
     const isUserCountExceedsUpperLimit = await User.isUserCountExceedsUpperLimit();