Shun Miyazawa 4 년 전
부모
커밋
8490e85d0e
1개의 변경된 파일60개의 추가작업 그리고 2개의 파일을 삭제
  1. 60 2
      packages/app/src/server/routes/apiv3/user-group.js

+ 60 - 2
packages/app/src/server/routes/apiv3/user-group.js

@@ -241,6 +241,36 @@ module.exports = (crowi) => {
     }
     }
   });
   });
 
 
+  /**
+   * @swagger
+   *
+   *  paths:
+   *    /selectable-parent-groups:
+   *      get:
+   *        tags: [UserGroup]
+   *        operationId: getSelectableParentGroups
+   *        summary: /selectable-parent-groups
+   *        description: Get selectable parent UserGroups
+   *        parameters:
+   *          - name: groupId
+   *            in: query
+   *            required: true
+   *            description: id of userGroup
+   *            schema:
+   *              type: string
+   *        responses:
+   *          200:
+   *            description: userGroups are fetched
+   *            content:
+   *              application/json:
+   *                schema:
+   *                  properties:
+   *                    userGroups:
+   *                      type: array
+   *                      items:
+   *                        type: object
+   *                      description: userGroup objects
+   */
   router.get('/selectable-parent-groups', loginRequiredStrictly, adminRequired, validator.selectableGroups, async(req, res) => {
   router.get('/selectable-parent-groups', loginRequiredStrictly, adminRequired, validator.selectableGroups, async(req, res) => {
     const { groupId } = req.query;
     const { groupId } = req.query;
 
 
@@ -265,8 +295,8 @@ module.exports = (crowi) => {
    *      get:
    *      get:
    *        tags: [UserGroup]
    *        tags: [UserGroup]
    *        operationId: getSelectableChildGroups
    *        operationId: getSelectableChildGroups
-   *        summary: /selectable-groups
-   *        description: Get selectable child user groups
+   *        summary: /selectable-child-groups
+   *        description: Get selectable child UserGroups
    *        parameters:
    *        parameters:
    *          - name: groupId
    *          - name: groupId
    *            in: query
    *            in: query
@@ -309,6 +339,34 @@ module.exports = (crowi) => {
     }
     }
   });
   });
 
 
+  /**
+   * @swagger
+   *
+   *  paths:
+   *    /user-groups/{id}:
+   *      get:
+   *        tags: [UserGroup]
+   *        operationId: getUserGroupFromGroupId
+   *        summary: /user-groups/{id}
+   *        description: Get UserGroup from Group ID
+   *        parameters:
+   *          - name: groupId
+   *            in: query
+   *            required: true
+   *            description: id of userGroup
+   *            schema:
+   *              type: string
+   *        responses:
+   *          200:
+   *            description: userGroup are fetched
+   *            content:
+   *              application/json:
+   *                schema:
+   *                  properties:
+   *                    userGroup:
+   *                      type: objedct
+   *                      description: userGroup object
+   */
   router.get('/:id', loginRequiredStrictly, adminRequired, validator.selectableGroups, async(req, res) => {
   router.get('/:id', loginRequiredStrictly, adminRequired, validator.selectableGroups, async(req, res) => {
     const { id: groupId } = req.params;
     const { id: groupId } = req.params;