Yuki Takei 1 год назад
Родитель
Сommit
26c1ff5105
25 измененных файлов с 139 добавлено и 217 удалено
  1. 65 0
      apps/app/bin/swagger-jsdoc/definition-apiv3.js
  2. 1 7
      apps/app/src/server/routes/apiv3/admin-home.js
  3. 0 6
      apps/app/src/server/routes/apiv3/app-settings.js
  4. 0 7
      apps/app/src/server/routes/apiv3/attachment.js
  5. 0 6
      apps/app/src/server/routes/apiv3/bookmarks.js
  6. 0 6
      apps/app/src/server/routes/apiv3/customize-setting.js
  7. 0 6
      apps/app/src/server/routes/apiv3/export.js
  8. 0 6
      apps/app/src/server/routes/apiv3/healthcheck.ts
  9. 0 6
      apps/app/src/server/routes/apiv3/import.js
  10. 0 6
      apps/app/src/server/routes/apiv3/markdown-setting.js
  11. 1 7
      apps/app/src/server/routes/apiv3/mongo.js
  12. 0 6
      apps/app/src/server/routes/apiv3/notification-setting.js
  13. 2 8
      apps/app/src/server/routes/apiv3/page/index.ts
  14. 0 6
      apps/app/src/server/routes/apiv3/pages/index.js
  15. 11 17
      apps/app/src/server/routes/apiv3/personal-setting.js
  16. 0 6
      apps/app/src/server/routes/apiv3/revisions.js
  17. 3 8
      apps/app/src/server/routes/apiv3/search.js
  18. 13 19
      apps/app/src/server/routes/apiv3/security-settings/index.js
  19. 1 7
      apps/app/src/server/routes/apiv3/share-links.js
  20. 0 6
      apps/app/src/server/routes/apiv3/slack-integration-legacy-settings.js
  21. 13 19
      apps/app/src/server/routes/apiv3/slack-integration-settings.js
  22. 0 5
      apps/app/src/server/routes/apiv3/statistics.js
  23. 1 7
      apps/app/src/server/routes/apiv3/user-group-relation.js
  24. 14 20
      apps/app/src/server/routes/apiv3/user-group.js
  25. 14 20
      apps/app/src/server/routes/apiv3/users.js

+ 65 - 0
apps/app/bin/swagger-jsdoc/definition-apiv3.js

@@ -25,4 +25,69 @@ module.exports = {
       },
     },
   },
+  'x-tagGroups': [
+    {
+      name: 'User API',
+      tags: [
+        'Attachment',
+        'Bookmarks',
+        'Page',
+        'Pages',
+        'Revisions',
+        'ShareLinks',
+        'Users',
+        '',
+        '',
+      ],
+    },
+    {
+      name: 'User Personal Settings API',
+      tags: [
+        'GeneralSetting',
+        'EditorSetting',
+        'InAppNotificationSettings',
+        '',
+        '',
+        '',
+        '',
+        '',
+      ],
+    },
+    {
+      name: 'System Management API',
+      tags: [
+        'Home',
+        'AppSettings',
+        'SecuritySetting',
+        'MarkDownSetting',
+        'CustomizeSetting',
+        'Import',
+        'Export',
+        'MongoDB',
+        'NotificationSetting',
+        'SlackIntegrationSettings',
+        'SlackIntegrationSettings (with proxy)',
+        'SlackIntegrationSettings (without proxy)',
+        'SlackIntegrationLegacySetting',
+        'ShareLink Management',
+        'UserGroupRelations',
+        'UserGroups',
+        'Users Management',
+        'FullTextSearch Management',
+      ],
+    },
+    {
+      name: 'Public API',
+      tags: [
+        'Healthcheck',
+        'Statistics',
+        '',
+        '',
+        '',
+        '',
+        '',
+        '',
+      ],
+    },
+  ]
 };

+ 1 - 7
apps/app/src/server/routes/apiv3/admin-home.js

@@ -4,12 +4,6 @@ const express = require('express');
 
 const router = express.Router();
 
-/**
- * @swagger
- *  tags:
- *    name: adminHome
- */
-
 /**
  * @swagger
  *
@@ -47,7 +41,7 @@ module.exports = (crowi) => {
    *
    *    /admin-home/:
    *      get:
-   *        tags: [AdminHome]
+   *        tags: [Admin]
    *        operationId: getAdminHome
    *        summary: /admin-home
    *        description: Get adminHome parameters

+ 0 - 6
apps/app/src/server/routes/apiv3/app-settings.js

@@ -18,12 +18,6 @@ const express = require('express');
 
 const router = express.Router();
 
-/**
- * @swagger
- *  tags:
- *    name: AppSettings
- */
-
 /**
  * @swagger
  *

+ 0 - 7
apps/app/src/server/routes/apiv3/attachment.js

@@ -24,13 +24,6 @@ const {
 } = require('express-validator');
 
 
-/**
- * @swagger
- *  tags:
- *    name: Attachment
- */
-
-
 /**
  * @swagger
  *

+ 0 - 6
apps/app/src/server/routes/apiv3/bookmarks.js

@@ -17,12 +17,6 @@ const { body, query, param } = require('express-validator');
 
 const router = express.Router();
 
-/**
- * @swagger
- *  tags:
- *    name: Bookmarks
- */
-
 /**
  * @swagger
  *

+ 0 - 6
apps/app/src/server/routes/apiv3/customize-setting.js

@@ -21,12 +21,6 @@ const logger = loggerFactory('growi:routes:apiv3:customize-setting');
 const router = express.Router();
 
 
-/**
- * @swagger
- *  tags:
- *    name: CustomizeSetting
- */
-
 /**
  * @swagger
  *

+ 0 - 6
apps/app/src/server/routes/apiv3/export.js

@@ -13,12 +13,6 @@ const { param } = require('express-validator');
 
 const router = express.Router();
 
-/**
- * @swagger
- *  tags:
- *    name: Export
- */
-
 /**
  * @swagger
  *

+ 0 - 6
apps/app/src/server/routes/apiv3/healthcheck.ts

@@ -13,12 +13,6 @@ const logger = loggerFactory('growi:routes:apiv3:healthcheck');
 
 const router = express.Router();
 
-/**
- * @swagger
- *  tags:
- *    name: Healthcheck
- */
-
 /**
  * @swagger
  *

+ 0 - 6
apps/app/src/server/routes/apiv3/import.js

@@ -17,12 +17,6 @@ const multer = require('multer');
 
 const router = express.Router();
 
-/**
- * @swagger
- *  tags:
- *    name: Import
- */
-
 /**
  * @swagger
  *

+ 0 - 6
apps/app/src/server/routes/apiv3/markdown-setting.js

@@ -32,12 +32,6 @@ const validator = {
 };
 
 
-/**
- * @swagger
- *  tags:
- *    name: MarkDownSetting
- */
-
 /**
  * @swagger
  *

+ 1 - 7
apps/app/src/server/routes/apiv3/mongo.js

@@ -7,12 +7,6 @@ const mongoose = require('mongoose');
 
 const router = express.Router();
 
-/**
- * @swagger
- *  tags:
- *    name: Mongo
- */
-
 module.exports = (crowi) => {
   const loginRequiredStrictly = require('../../middlewares/login-required')(crowi);
   const adminRequired = require('../../middlewares/admin-required')(crowi);
@@ -22,7 +16,7 @@ module.exports = (crowi) => {
    *
    *  /mongo/collections:
    *    get:
-   *      tags: [Mongo]
+   *      tags: [MongoDB]
    *      operationId: getMongoCollections
    *      summary: /mongo/collections
    *      description: get mongodb collections names

+ 0 - 6
apps/app/src/server/routes/apiv3/notification-setting.js

@@ -41,12 +41,6 @@ const validator = {
   ],
 };
 
-/**
- * @swagger
- *  tags:
- *    name: NotificationSetting
- */
-
 /**
  * @swagger
  *

+ 2 - 8
apps/app/src/server/routes/apiv3/page/index.ts

@@ -46,12 +46,6 @@ const { body, query, param } = require('express-validator');
 
 const router = express.Router();
 
-/**
- * @swagger
- *  tags:
- *    name: Page
- */
-
 
 /**
  * @swagger
@@ -671,9 +665,9 @@ module.exports = (crowi) => {
   /**
   * @swagger
   *
-  *    /pages/export:
+  *    /page/export:
   *      get:
-  *        tags: [Export]
+  *        tags: [Page]
   *        description: return page's markdown
   *        responses:
   *          200:

+ 0 - 6
apps/app/src/server/routes/apiv3/pages/index.js

@@ -27,12 +27,6 @@ const router = express.Router();
 const LIMIT_FOR_LIST = 10;
 const LIMIT_FOR_MULTIPLE_PAGE_OP = 20;
 
-/**
- * @swagger
- *  tags:
- *    name: Pages
- */
-
 /**
  * @swagger
  *

+ 11 - 17
apps/app/src/server/routes/apiv3/personal-setting.js

@@ -21,12 +21,6 @@ const passport = require('passport');
 
 const router = express.Router();
 
-/**
- * @swagger
- *  tags:
- *    name: PersonalSetting
- */
-
 /**
  * @swagger
  *
@@ -136,7 +130,7 @@ module.exports = (crowi) => {
    *
    *    /personal-setting:
    *      get:
-   *        tags: [PersonalSetting]
+   *        tags: [GeneralSetting]
    *        operationId: getPersonalSetting
    *        summary: /personal-setting
    *        description: Get personal parameters
@@ -175,7 +169,7 @@ module.exports = (crowi) => {
    *
    *    /personal-setting/is-password-set:
    *      get:
-   *        tags: [PersonalSetting]
+   *        tags: [GeneralSetting]
    *        operationId: getIsPasswordSet
    *        summary: /personal-setting
    *        description: Get whether a password has been set
@@ -210,7 +204,7 @@ module.exports = (crowi) => {
    *
    *    /personal-setting:
    *      put:
-   *        tags: [PersonalSetting]
+   *        tags: [GeneralSetting]
    *        operationId: updatePersonalSetting
    *        summary: /personal-setting
    *        description: Update personal setting
@@ -267,7 +261,7 @@ module.exports = (crowi) => {
    *
    *    /personal-setting/image-type:
    *      put:
-   *        tags: [PersonalSetting]
+   *        tags: [GeneralSetting]
    *        operationId: putUserImageType
    *        summary: /personal-setting/image-type
    *        description: Update user image type
@@ -304,7 +298,7 @@ module.exports = (crowi) => {
    *
    *    /personal-setting/external-accounts:
    *      get:
-   *        tags: [PersonalSetting]
+   *        tags: [GeneralSetting]
    *        operationId: getExternalAccounts
    *        summary: /personal-setting/external-accounts
    *        description: Get external accounts that linked current user
@@ -338,7 +332,7 @@ module.exports = (crowi) => {
    *
    *    /personal-setting/password:
    *      put:
-   *        tags: [PersonalSetting]
+   *        tags: [GeneralSetting]
    *        operationId: putUserPassword
    *        summary: /personal-setting/password
    *        description: Update user password
@@ -386,7 +380,7 @@ module.exports = (crowi) => {
    *
    *    /personal-setting/api-token:
    *      put:
-   *        tags: [PersonalSetting]
+   *        tags: [GeneralSetting]
    *        operationId: putUserApiToken
    *        summary: /personal-setting/api-token
    *        description: Update user api token
@@ -424,7 +418,7 @@ module.exports = (crowi) => {
    *
    *    /personal-setting/associate-ldap:
    *      put:
-   *        tags: [PersonalSetting]
+   *        tags: [GeneralSetting]
    *        operationId: associateLdapAccount
    *        summary: /personal-setting/associate-ldap
    *        description: associate Ldap account
@@ -476,7 +470,7 @@ module.exports = (crowi) => {
    *
    *    /personal-setting/disassociate-ldap:
    *      put:
-   *        tags: [PersonalSetting]
+   *        tags: [GeneralSetting]
    *        operationId: disassociateLdapAccount
    *        summary: /personal-setting/disassociate-ldap
    *        description: disassociate Ldap account
@@ -609,7 +603,7 @@ module.exports = (crowi) => {
    *
    *    /personal-setting/in-app-notification-settings:
    *      put:
-   *        tags: [in-app-notification-settings]
+   *        tags: [InAppNotificationSettings]
    *        operationId: putInAppNotificationSettings
    *        summary: personal-setting/in-app-notification-settings
    *        description: Put InAppNotificationSettings
@@ -653,7 +647,7 @@ module.exports = (crowi) => {
    *
    *    /personal-setting/in-app-notification-settings:
    *      get:
-   *        tags: [in-app-notification-settings]
+   *        tags: [InAppNotificationSettings]
    *        operationId: getInAppNotificationSettings
    *        summary: personal-setting/in-app-notification-settings
    *        description: Get InAppNotificationSettings

+ 0 - 6
apps/app/src/server/routes/apiv3/revisions.js

@@ -17,12 +17,6 @@ const router = express.Router();
 
 const MIGRATION_FILE_NAME = '20211227060705-revision-path-to-page-id-schema-migration--fixed-7549';
 
-/**
- * @swagger
- *  tags:
- *    name: Revisions
- */
-
 module.exports = (crowi) => {
   const certifySharedPage = require('../../middlewares/certify-shared-page')(crowi);
   const accessTokenParser = require('../../middlewares/access-token-parser')(crowi);

+ 3 - 8
apps/app/src/server/routes/apiv3/search.js

@@ -16,11 +16,6 @@ const router = express.Router();
 
 const noCache = require('nocache');
 
-/**
- * @swagger
- *  tags:
- *    name: Search
- */
 module.exports = (crowi) => {
   const accessTokenParser = require('../../middlewares/access-token-parser')(crowi);
   const loginRequired = require('../../middlewares/login-required')(crowi);
@@ -34,7 +29,7 @@ module.exports = (crowi) => {
    *
    *  /search/indices:
    *    get:
-   *      tags: [Search]
+   *      tags: [FullTextSearch Management]
    *      summary: /search/indices
    *      description: Get current status of indices
    *      responses:
@@ -68,7 +63,7 @@ module.exports = (crowi) => {
    *
    *  /search/connection:
    *    get:
-   *      tags: [Search]
+   *      tags: [FullTextSearch Management]
    *      summary: /search/connection
    *      description: Reconnect to Elasticsearch
    *      responses:
@@ -103,7 +98,7 @@ module.exports = (crowi) => {
    *
    *  /search/indices:
    *    put:
-   *      tags: [Search]
+   *      tags: [FullTextSearch Management]
    *      summary: /search/indices
    *      description: Operate indices
    *      requestBody:

+ 13 - 19
apps/app/src/server/routes/apiv3/security-settings/index.js

@@ -108,12 +108,6 @@ const validator = {
   ],
 };
 
-/**
- * @swagger
- *  tags:
- *    name: SecuritySetting
- */
-
 
 /**
  * @swagger
@@ -335,7 +329,7 @@ module.exports = (crowi) => {
    *
    *    /security-setting/:
    *      get:
-   *        tags: [SecuritySetting, apiv3]
+   *        tags: [SecuritySetting]
    *        description: Get security paramators
    *        responses:
    *          200:
@@ -463,7 +457,7 @@ module.exports = (crowi) => {
    *
    *    /security-setting/authentication/enabled:
    *      put:
-   *        tags: [SecuritySetting, apiv3]
+   *        tags: [SecuritySetting]
    *        description: Update authentication isEnabled
    *        requestBody:
    *          required: true
@@ -578,7 +572,7 @@ module.exports = (crowi) => {
    *
    *    /security-setting/authentication:
    *      get:
-   *        tags: [SecuritySetting, apiv3]
+   *        tags: [SecuritySetting]
    *        description: Get setup strategies for passport
    *        responses:
    *          200:
@@ -606,7 +600,7 @@ module.exports = (crowi) => {
    *
    *    /security-setting/general-setting:
    *      put:
-   *        tags: [SecuritySetting, apiv3]
+   *        tags: [SecuritySetting]
    *        description: Update GeneralSetting
    *        requestBody:
    *          required: true
@@ -692,7 +686,7 @@ module.exports = (crowi) => {
    *
    *    /security-setting/share-link-setting:
    *      put:
-   *        tags: [SecuritySetting, apiv3]
+   *        tags: [SecuritySetting]
    *        description: Update ShareLink Setting
    *        requestBody:
    *          required: true
@@ -735,7 +729,7 @@ module.exports = (crowi) => {
    *
    *    /security-setting/all-share-links:
    *      get:
-   *        tags: [ShareLinkSettings, apiv3]
+   *        tags: [SecuritySetting]
    *        description: Get All ShareLinks at Share Link Setting
    *        responses:
    *          200:
@@ -778,7 +772,7 @@ module.exports = (crowi) => {
    *
    *    /security-setting/all-share-links:
    *      delete:
-   *        tags: [ShareLinkSettings, apiv3]
+   *        tags: [SecuritySetting]
    *        description: Delete All ShareLinks at Share Link Setting
    *        responses:
    *          200:
@@ -803,7 +797,7 @@ module.exports = (crowi) => {
    *
    *    /security-setting/local-setting:
    *      put:
-   *        tags: [LocalSetting, apiv3]
+   *        tags: [SecuritySetting]
    *        description: Update LocalSetting
    *        requestBody:
    *          required: true
@@ -855,7 +849,7 @@ module.exports = (crowi) => {
    *
    *    /security-setting/ldap:
    *      put:
-   *        tags: [SecuritySetting, apiv3]
+   *        tags: [SecuritySetting]
    *        description: Update LDAP setting
    *        requestBody:
    *          required: true
@@ -920,7 +914,7 @@ module.exports = (crowi) => {
    *
    *    /security-setting/saml:
    *      put:
-   *        tags: [SecuritySetting, apiv3]
+   *        tags: [SecuritySetting]
    *        description: Update SAML setting
    *        requestBody:
    *          required: true
@@ -1013,7 +1007,7 @@ module.exports = (crowi) => {
    *
    *    /security-setting/oidc:
    *      put:
-   *        tags: [SecuritySetting, apiv3]
+   *        tags: [SecuritySetting]
    *        description: Update OpenID Connect setting
    *        requestBody:
    *          required: true
@@ -1090,7 +1084,7 @@ module.exports = (crowi) => {
    *
    *    /security-setting/google-oauth:
    *      put:
-   *        tags: [SecuritySetting, apiv3]
+   *        tags: [SecuritySetting]
    *        description: Update google OAuth
    *        requestBody:
    *          required: true
@@ -1138,7 +1132,7 @@ module.exports = (crowi) => {
    *
    *    /security-setting/github-oauth:
    *      put:
-   *        tags: [SecuritySetting, apiv3]
+   *        tags: [SecuritySetting]
    *        description: Update github OAuth
    *        requestBody:
    *          required: true

+ 1 - 7
apps/app/src/server/routes/apiv3/share-links.js

@@ -20,12 +20,6 @@ const validator = {};
 
 const today = new Date();
 
-/**
- * @swagger
- *  tags:
- *    name: ShareLink
- */
-
 module.exports = (crowi) => {
   const loginRequired = require('../../middlewares/login-required')(crowi);
   const adminRequired = require('../../middlewares/admin-required')(crowi);
@@ -212,7 +206,7 @@ module.exports = (crowi) => {
   *
   *    /share-links/all:
   *      delete:
-  *        tags: [ShareLinks]
+  *        tags: [ShareLink Management]
   *        description: delete all share links
   *        responses:
   *          200:

+ 0 - 6
apps/app/src/server/routes/apiv3/slack-integration-legacy-settings.js

@@ -22,12 +22,6 @@ const validator = {
   ],
 };
 
-/**
- * @swagger
- *  tags:
- *    name: SlackIntegrationLegacySetting
- */
-
 /**
  * @swagger
  *

+ 13 - 19
apps/app/src/server/routes/apiv3/slack-integration-settings.js

@@ -25,12 +25,6 @@ const logger = loggerFactory('growi:routes:apiv3:slack-integration-settings');
 const router = express.Router();
 
 
-/**
- * @swagger
- *  tags:
- *    name: SlackIntegrationSettings
- */
-
 /**
  * @swagger
  *
@@ -166,9 +160,9 @@ module.exports = (crowi) => {
    *
    *    /slack-integration-settings/:
    *      get:
-   *        tags: [SlackBotSettingParams]
+   *        tags: [SlackIntegrationSettings]
    *        operationId: getSlackBotSettingParams
-   *        summary: get /slack-integration
+   *        summary: /slack-integration
    *        description: Get current settings and connection statuses.
    *        responses:
    *          200:
@@ -295,7 +289,7 @@ module.exports = (crowi) => {
    *
    *    /slack-integration-settings/bot-type/:
    *      put:
-   *        tags: [botType]
+   *        tags: [SlackIntegrationSettings]
    *        operationId: putBotType
    *        summary: /slack-integration/bot-type
    *        description: Put botType setting.
@@ -334,7 +328,7 @@ module.exports = (crowi) => {
    *
    *    /slack-integration/bot-type/:
    *      delete:
-   *        tags: [botType]
+   *        tags: [SlackIntegrationSettings]
    *        operationId: deleteBotType
    *        summary: /slack-integration/bot-type
    *        description: Delete botType setting.
@@ -365,7 +359,7 @@ module.exports = (crowi) => {
    *
    *    /slack-integration-settings/without-proxy/update-settings/:
    *      put:
-   *        tags: [UpdateWithoutProxySettings]
+   *        tags: [SlackIntegrationSettings (without proxy)]
    *        operationId: putWithoutProxySettings
    *        summary: update customBotWithoutProxy settings
    *        description: Update customBotWithoutProxy setting.
@@ -405,7 +399,7 @@ module.exports = (crowi) => {
    *
    *    /slack-integration-settings/without-proxy/update-permissions/:
    *      put:
-   *        tags: [UpdateWithoutProxyPermissions]
+   *        tags: [SlackIntegrationSettings (without proxy)]
    *        operationId: putWithoutProxyPermissions
    *        summary: update customBotWithoutProxy permissions
    *        description: Update customBotWithoutProxy permissions.
@@ -448,7 +442,7 @@ module.exports = (crowi) => {
    *
    *    /slack-integration-settings/slack-app-integrations:
    *      post:
-   *        tags: [SlackIntegration]
+   *        tags: [SlackIntegrationSettings (with proxy)]
    *        operationId: putSlackAppIntegrations
    *        summary: /slack-integration
    *        description: Generate SlackAppIntegrations
@@ -498,7 +492,7 @@ module.exports = (crowi) => {
    *
    *    /slack-integration-settings/slack-app-integrations/:id:
    *      delete:
-   *        tags: [SlackIntegration]
+   *        tags: [SlackIntegrationSettings (with proxy)]
    *        operationId: deleteAccessTokens
    *        summary: delete accessTokens
    *        description: Delete accessTokens
@@ -556,7 +550,7 @@ module.exports = (crowi) => {
    *
    *    /slack-integration-settings/slack-app-integrations/:id/makeprimary:
    *      put:
-   *        tags: [SlackIntegration]
+   *        tags: [SlackIntegrationSettings (with proxy)]
    *        operationId: makePrimary
    *        summary: /slack-integration
    *        description: Make SlackAppTokens primary
@@ -603,7 +597,7 @@ module.exports = (crowi) => {
    *
    *    /slack-integration-settings/slack-app-integrations/:id/regenerate-tokens:
    *      put:
-   *        tags: [SlackIntegration]
+   *        tags: [SlackIntegrationSettings (with proxy)]
    *        operationId: putRegenerateTokens
    *        summary: /slack-integration
    *        description: Regenerate SlackAppTokens
@@ -636,7 +630,7 @@ module.exports = (crowi) => {
    *
    *    /slack-integration-settings/slack-app-integrations/:id/permissions:
    *      put:
-   *        tags: [SlackIntegration]
+   *        tags: [SlackIntegrationSettings (with proxy)]
    *        operationId: putSupportedCommands
    *        summary: /slack-integration-settings/:id/permissions
    *        description: update supported commands
@@ -695,7 +689,7 @@ module.exports = (crowi) => {
    *
    *    /slack-integration-settings/slack-app-integrations/:id/relation-test:
    *      post:
-   *        tags: [botType]
+   *        tags: [SlackIntegrationSettings (with proxy)]
    *        operationId: postRelationTest
    *        summary: Test relation
    *        description: Delete botType setting.
@@ -766,7 +760,7 @@ module.exports = (crowi) => {
    *
    *    /slack-integration-settings/without-proxy/test:
    *      post:
-   *        tags: [botType]
+   *        tags: [SlackIntegrationSettings (without proxy)]
    *        operationId: postTest
    *        summary: test the connection
    *        description: Test the connection with slack work space.

+ 0 - 5
apps/app/src/server/routes/apiv3/statistics.js

@@ -17,11 +17,6 @@ const USER_STATUS_MASTER = {
 };
 
 
-/**
- * @swagger
- *  tags:
- *    name: Statistics
- */
 module.exports = (crowi) => {
 
   const models = crowi.models;

+ 1 - 7
apps/app/src/server/routes/apiv3/user-group-relation.js

@@ -13,12 +13,6 @@ const router = express.Router();
 
 const validator = {};
 
-/**
- * @swagger
- *  tags:
- *    name: UserGroupRelation
- */
-
 module.exports = (crowi) => {
   const loginRequiredStrictly = require('../../middlewares/login-required')(crowi);
   const adminRequired = require('../../middlewares/admin-required')(crowi);
@@ -33,7 +27,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /user-group-relations:
    *      get:
-   *        tags: [UserGroupRelation]
+   *        tags: [UserGroupRelations]
    *        operationId: listUserGroupRelations
    *        summary: /user-group-relations
    *        description: Gets the user group relations

+ 14 - 20
apps/app/src/server/routes/apiv3/user-group.js

@@ -24,12 +24,6 @@ const logger = loggerFactory('growi:routes:apiv3:user-group'); // eslint-disable
 const router = express.Router();
 
 
-/**
- * @swagger
- *  tags:
- *    name: UserGroup
- */
-
 module.exports = (crowi) => {
   const loginRequiredStrictly = require('../../middlewares/login-required')(crowi);
   const adminRequired = require('../../middlewares/admin-required')(crowi);
@@ -94,7 +88,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /user-groups:
    *      get:
-   *        tags: [UserGroup]
+   *        tags: [UserGroups]
    *        operationId: getUserGroup
    *        summary: /user-groups
    *        description: Get usergroups
@@ -137,7 +131,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /ancestors:
    *      get:
-   *        tags: [UserGroup]
+   *        tags: [UserGroups]
    *        operationId: getAncestorUserGroups
    *        summary: /ancestors
    *        description: Get ancestor user groups.
@@ -200,7 +194,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /user-groups:
    *      post:
-   *        tags: [UserGroup]
+   *        tags: [UserGroups]
    *        operationId: createUserGroup
    *        summary: /user-groups
    *        description: Adds userGroup
@@ -250,7 +244,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /selectable-parent-groups:
    *      get:
-   *        tags: [UserGroup]
+   *        tags: [UserGroups]
    *        operationId: getSelectableParentGroups
    *        summary: /selectable-parent-groups
    *        description: Get selectable parent UserGroups
@@ -299,7 +293,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /selectable-child-groups:
    *      get:
-   *        tags: [UserGroup]
+   *        tags: [UserGroups]
    *        operationId: getSelectableChildGroups
    *        summary: /selectable-child-groups
    *        description: Get selectable child UserGroups
@@ -351,7 +345,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /user-groups/{id}:
    *      get:
-   *        tags: [UserGroup]
+   *        tags: [UserGroups]
    *        operationId: getUserGroupFromGroupId
    *        summary: /user-groups/{id}
    *        description: Get UserGroup from Group ID
@@ -393,7 +387,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /user-groups/{id}:
    *      delete:
-   *        tags: [UserGroup]
+   *        tags: [UserGroups]
    *        operationId: deleteUserGroup
    *        summary: /user-groups/{id}
    *        description: Deletes userGroup
@@ -457,7 +451,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /user-groups/{id}:
    *      put:
-   *        tags: [UserGroup]
+   *        tags: [UserGroups]
    *        operationId: updateUserGroups
    *        summary: /user-groups/{id}
    *        description: Update userGroup
@@ -507,7 +501,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /user-groups/{id}/users:
    *      get:
-   *        tags: [UserGroup]
+   *        tags: [UserGroups]
    *        operationId: getUsersUserGroups
    *        summary: /user-groups/{id}/users
    *        description: Get users related to the userGroup
@@ -558,7 +552,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /user-groups/{id}/unrelated-users:
    *      get:
-   *        tags: [UserGroup]
+   *        tags: [UserGroups]
    *        operationId: getUnrelatedUsersUserGroups
    *        summary: /user-groups/{id}/unrelated-users
    *        description: Get users unrelated to the userGroup
@@ -619,7 +613,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /user-groups/{id}/users:
    *      post:
-   *        tags: [UserGroup]
+   *        tags: [UserGroups]
    *        operationId: addUserUserGroups
    *        summary: /user-groups/{id}/users
    *        description: Add a user to the userGroup
@@ -686,7 +680,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /user-groups/{id}/users:
    *      delete:
-   *        tags: [UserGroup]
+   *        tags: [UserGroups]
    *        operationId: deleteUsersUserGroups
    *        summary: /user-groups/{id}/users
    *        description: remove a user from the userGroup
@@ -738,7 +732,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /user-groups/{id}/user-group-relations:
    *      get:
-   *        tags: [UserGroup]
+   *        tags: [UserGroups]
    *        operationId: getUserGroupRelationsUserGroups
    *        summary: /user-groups/{id}/user-group-relations
    *        description: Get the user group relations for the userGroup
@@ -785,7 +779,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /user-groups/{id}/pages:
    *      get:
-   *        tags: [UserGroup]
+   *        tags: [UserGroups]
    *        operationId: getPagesUserGroups
    *        summary: /user-groups/{id}/pages
    *        description: Get closed pages for the userGroup

+ 14 - 20
apps/app/src/server/routes/apiv3/users.js

@@ -30,12 +30,6 @@ const PAGE_ITEMS = 50;
 
 const validator = {};
 
-/**
- * @swagger
- *  tags:
- *    name: Users
- */
-
 /**
  * @swagger
  *
@@ -408,7 +402,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /users/invite:
    *      post:
-   *        tags: [Users]
+   *        tags: [Users Management]
    *        operationId: inviteUser
    *        summary: /users/invite
    *        description: Create new users and send Emails
@@ -476,7 +470,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /users/{id}/grant-admin:
    *      put:
-   *        tags: [Users]
+   *        tags: [Users Management]
    *        operationId: grantAdminUser
    *        summary: /users/{id}/grant-admin
    *        description: Grant user admin
@@ -523,7 +517,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /users/{id}/revoke-admin:
    *      put:
-   *        tags: [Users]
+   *        tags: [Users Management]
    *        operationId: revokeAdminUser
    *        summary: /users/{id}/revoke-admin
    *        description: Revoke user admin
@@ -570,7 +564,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /users/{id}/grant-read-only:
    *      put:
-   *        tags: [Users]
+   *        tags: [Users Management]
    *        operationId: ReadOnly
    *        summary: /users/{id}/grant-read-only
    *        description: Grant user read only access
@@ -622,7 +616,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /users/{id}/revoke-read-only:
    *      put:
-   *        tags: [Users]
+   *        tags: [Users Management]
    *        operationId: revokeReadOnly
    *        summary: /users/{id}/revoke-read-only
    *        description: Revoke user read only access
@@ -674,7 +668,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /users/{id}/activate:
    *      put:
-   *        tags: [Users]
+   *        tags: [Users Management]
    *        operationId: activateUser
    *        summary: /users/{id}/activate
    *        description: Activate user
@@ -728,7 +722,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /users/{id}/deactivate:
    *      put:
-   *        tags: [Users]
+   *        tags: [Users Management]
    *        operationId: deactivateUser
    *        summary: /users/{id}/deactivate
    *        description: Deactivate user
@@ -775,7 +769,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /users/{id}/remove:
    *      delete:
-   *        tags: [Users]
+   *        tags: [Users Management]
    *        operationId: removeUser
    *        summary: /users/{id}/remove
    *        description: Delete user
@@ -835,7 +829,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /users/external-accounts:
    *      get:
-   *        tags: [Users]
+   *        tags: [Users Management]
    *        operationId: listExternalAccountsUsers
    *        summary: /users/external-accounts
    *        description: Get external-account
@@ -868,7 +862,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /users/external-accounts/{id}/remove:
    *      delete:
-   *        tags: [Users]
+   *        tags: [Users Management]
    *        operationId: removeExternalAccountUser
    *        summary: /users/external-accounts/{id}/remove
    *        description: Delete ExternalAccount
@@ -911,7 +905,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /users/update.imageUrlCache:
    *      put:
-   *        tags: [Users]
+   *        tags: [Users Management]
    *        operationId: update.imageUrlCache
    *        summary: /users/update.imageUrlCache
    *        description: update imageUrlCache
@@ -963,7 +957,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /users/reset-password:
    *      put:
-   *        tags: [Users]
+   *        tags: [Users Management]
    *        operationId: resetPassword
    *        summary: /users/reset-password
    *        description: update imageUrlCache
@@ -1004,7 +998,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /users/reset-password-email:
    *      put:
-   *        tags: [Users]
+   *        tags: [Users Management]
    *        operationId: resetPasswordEmail
    *        summary: /users/reset-password-email
    *        description: send new password email
@@ -1051,7 +1045,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /users/send-invitation-email:
    *      put:
-   *        tags: [Users]
+   *        tags: [Users Management]
    *        operationId: sendInvitationEmail
    *        summary: /users/send-invitation-email
    *        description: send invitation email