added more swagger

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

@@ -11,10 +11,35 @@ const {
   adminRequired,
 } = require('../../util/middlewares');
 
+/**
+ * @swagger
+ *  tags:
+ *    name: UserGroupRelation
+ */
 
 module.exports = (crowi) => {
   const { ErrorV3, UserGroup, UserGroupRelation } = crowi.models;
 
+  /**
+   * @swagger
+   *  paths:
+   *    /_api/v3/user-group-relations:
+   *      get:
+   *        tags: [UserGroupRelation]
+   *        description: Gets the user group relations
+   *        produces:
+   *          - application/json
+   *        responses:
+   *          200:
+   *            description: user group relations are fetched
+   *            content:
+   *              application/json:
+   *                schema:
+   *                  properties:
+   *                    userGroupRelations:
+   *                      type: object
+   *                      description: contains arrays user objects related
+   */
   router.get('/', loginRequired(crowi), adminRequired(), async(req, res) => {
     // TODO: filter with querystring? or body
     try {

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

@@ -21,6 +21,7 @@ const validator = {};
  *  tags:
  *    name: UserGroup
  */
+
 module.exports = (crowi) => {
   const { ErrorV3, UserGroup, UserGroupRelation } = crowi.models;
   const { ApiV3FormValidator } = crowi.middlewares;
@@ -29,7 +30,7 @@ module.exports = (crowi) => {
    * @swagger
    *
    *  paths:
-   *    /usergroup:
+   *    /_api/v3/user-groups:
    *      get:
    *        tags: [UserGroup]
    *        description: Gets usergroups
@@ -37,7 +38,7 @@ module.exports = (crowi) => {
    *          - application/json
    *        responses:
    *          200:
-   *            description: Returns usergroups
+   *            description: usergroups are fetched
    *            content:
    *              application/json:
    *                schema:
@@ -67,7 +68,7 @@ module.exports = (crowi) => {
    * @swagger
    *
    *  paths:
-   *    /usergroup:
+   *    /_api/v3/user-groups:
    *      post:
    *        tags: [UserGroup]
    *        description: Adds userGroup
@@ -119,7 +120,7 @@ module.exports = (crowi) => {
    * @swagger
    *
    *  paths:
-   *    /usergroup/{:id}:
+   *    /_api/v3/user-groups/{:id}:
    *      delete:
    *        tags: [UserGroup]
    *        description: Deletes userGroup
@@ -180,7 +181,7 @@ module.exports = (crowi) => {
    * @swagger
    *
    *  paths:
-   *    /usergroup/{:id/users}:
+   *    /_api/v3/user-groups/{:id/users}:
    *      get:
    *        tags: [UserGroup]
    *        description: Gets the users related to the userGroup