itizawa 6 лет назад
Родитель
Сommit
06bf0ba06c
1 измененных файлов с 19 добавлено и 1 удалено
  1. 19 1
      src/server/routes/apiv3/users.js

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

@@ -32,7 +32,25 @@ module.exports = (crowi) => {
 
   const { ApiV3FormValidator } = crowi.middlewares;
 
-  // TODO writte swagger
+  /**
+   * @swagger
+   *
+   *  paths:
+   *    /_api/v3/users:
+   *      get:
+   *        tags: [Users]
+   *        description: Get users
+   *        responses:
+   *          200:
+   *            description: users are fetched
+   *            content:
+   *              application/json:
+   *                schema:
+   *                  properties:
+   *                    users:
+   *                      type: object
+   *                      description: a result of `Users.find`
+   */
   router.get('/', loginRequiredStrictly, adminRequired, async(req, res) => {
     try {
       const page = parseInt(req.query.page) || 1;