Просмотр исходного кода

Merge pull request #9793 from goofmint/fix/doc-v3-user-group-relation

support(jsdoc): Add swagger document to user-group-relation.js
Yuki Takei 1 год назад
Родитель
Сommit
95fa921439
1 измененных файлов с 11 добавлено и 0 удалено
  1. 11 0
      apps/app/src/server/routes/apiv3/user-group-relation.js

+ 11 - 0
apps/app/src/server/routes/apiv3/user-group-relation.js

@@ -29,6 +29,8 @@ module.exports = (crowi) => {
    *    /user-group-relations:
    *    /user-group-relations:
    *      get:
    *      get:
    *        tags: [UserGroupRelations]
    *        tags: [UserGroupRelations]
+   *        security:
+   *          - cookieAuth: []
    *        operationId: listUserGroupRelations
    *        operationId: listUserGroupRelations
    *        summary: /user-group-relations
    *        summary: /user-group-relations
    *        description: Gets the user group relations
    *        description: Gets the user group relations
@@ -42,6 +44,15 @@ module.exports = (crowi) => {
    *                    userGroupRelations:
    *                    userGroupRelations:
    *                      type: object
    *                      type: object
    *                      description: contains arrays user objects related
    *                      description: contains arrays user objects related
+   *                      properties:
+   *                        userGroupRelations:
+   *                          type: array
+   *                          items:
+   *                            type: object
+   *                        relationsOfChildGroups:
+   *                          type: array
+   *                          items:
+   *                            type: object
    */
    */
   router.get('/', loginRequiredStrictly, adminRequired, validator.list, async(req, res) => {
   router.get('/', loginRequiredStrictly, adminRequired, validator.list, async(req, res) => {
     const { query } = req;
     const { query } = req;