adjust

src/server/routes/apiv3/user-group.js

@@ -137,7 +137,7 @@ module.exports = (crowi) => {
    *            required: true
    *            description: id of userGroup
    *            schema:
-   *              type: object
+   *              type: string
    *          - name: actionName
    *            in: query
    *            description: name of action
@@ -147,7 +147,7 @@ module.exports = (crowi) => {
    *            in: query
    *            description: userGroup id that will be transferred to
    *            schema:
-   *              type: object
+   *              type: string
    *        responses:
    *          200:
    *            description: userGroup is removed
@@ -197,7 +197,7 @@ module.exports = (crowi) => {
    *            required: true
    *            description: id of userGroup
    *            schema:
-   *              type: object
+   *              type: string
    *        responses:
    *          200:
    *            description: userGroup is updated
@@ -252,7 +252,7 @@ module.exports = (crowi) => {
    *            required: true
    *            description: id of userGroup
    *            schema:
-   *              type: object
+   *              type: string
    *        responses:
    *          200:
    *            description: users are fetched
@@ -300,7 +300,7 @@ module.exports = (crowi) => {
    *            required: true
    *            description: id of userGroup
    *            schema:
-   *              type: object
+   *              type: string
    *        responses:
    *          200:
    *            description: users are fetched
@@ -349,7 +349,7 @@ module.exports = (crowi) => {
    *            required: true
    *            description: id of userGroup
    *            schema:
-   *              type: object
+   *              type: string
    *        responses:
    *          200:
    *            description: a user is added
@@ -408,7 +408,7 @@ module.exports = (crowi) => {
    *            required: true
    *            description: id of userGroup
    *            schema:
-   *              type: object
+   *              type: string
    *        responses:
    *          200:
    *            description: a user was removed
@@ -468,7 +468,7 @@ module.exports = (crowi) => {
    *            required: true
    *            description: id of userGroup
    *            schema:
-   *              type: object
+   *              type: string
    *        responses:
    *          200:
    *            description: user group relations are fetched
@@ -520,7 +520,7 @@ module.exports = (crowi) => {
    *            required: true
    *            description: id of userGroup
    *            schema:
-   *              type: object
+   *              type: string
    *        responses:
    *          200:
    *            description: pages are fetched

src/server/routes/apiv3/users.js

@@ -1,6 +1,3 @@
-const loggerFactory = require('@alias/logger');
-
-const logger = loggerFactory('growi:routes:apiv3:user-group'); // eslint-disable-line no-unused-vars
 
 const express = require('express');
 
@@ -11,6 +8,13 @@ const { isEmail } = require('validator');
 
 const validator = {};
 
+/**
+ * @swagger
+ *  tags:
+ *    name: Users
+ */
+
+
 module.exports = (crowi) => {
   const loginRequiredStrictly = require('../../middleware/login-required')(crowi);
   const adminRequired = require('../../middleware/admin-required')(crowi);
@@ -78,7 +82,32 @@ module.exports = (crowi) => {
       return res.apiv3Err(new ErrorV3(err));
     }
   });
-
+  /**
+   * @swagger
+   *
+   *  paths:
+   *    /_api/v3/users/{id}/remove:
+   *      delete:
+   *        tags: [Users]
+   *        description: Delete user
+   *        parameters:
+   *          - name: id
+   *            in: path
+   *            required: true
+   *            description: id of delete user
+   *            schema:
+   *              type: string
+   *        responses:
+   *          200:
+   *            description: Deleting user success
+   *            content:
+   *              application/json:
+   *                schema:
+   *                  properties:
+   *                    userData:
+   *                      type: object
+   *                      description: data of delete user
+   */
   router.delete('/:id/remove', loginRequiredStrictly, adminRequired, csrf, async(req, res) => {
     const { id } = req.params;
 

src/server/util/middlewares.js

@@ -1,7 +1,6 @@
 // don't add any more middlewares to this file.
 // all new middlewares should be an independent file under /server/routes/middlewares
 // eslint-disable-next-line no-unused-vars
-
 const logger = require('@alias/logger')('growi:lib:middlewares');
 
 const { formatDistanceStrict } = require('date-fns');