فهرست منبع

remove apiv3 tags from api v3 reference

Ryu Sato 6 سال پیش
والد
کامیت
b4bf4ca173

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

@@ -48,7 +48,7 @@ module.exports = (crowi) => {
    *
    *    /_api/v3//admin-home/:
    *      get:
-   *        tags: [adminHome, apiv3]
+   *        tags: [adminHome]
    *        operationId: getAdminHome
    *        summary: /_api/v3//admin-home/
    *        description: Get adminHome parameters

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

@@ -138,7 +138,7 @@ module.exports = (crowi) => {
    *
    *    /_api/v3/app-settings:
    *      get:
-   *        tags: [AppSettings, apiv3]
+   *        tags: [AppSettings]
    *        operationId: getAppSettings
    *        summary: /_api/v3/app-settings
    *        description: get app setting params
@@ -183,7 +183,7 @@ module.exports = (crowi) => {
    *
    *    /_api/v3/app-settings/app-setting:
    *      put:
-   *        tags: [AppSettings, apiv3]
+   *        tags: [AppSettings]
    *        summary: /_api/v3/app-settings/app-setting
    *        operationId: updateAppSettings
    *        description: Update app setting
@@ -232,7 +232,7 @@ module.exports = (crowi) => {
    *
    *    /_api/v3/app-settings/site-url-setting:
    *      put:
-   *        tags: [AppSettings, apiv3]
+   *        tags: [AppSettings]
    *        operationId: updateAppSettingSiteUrlSetting
    *        summary: /_api/v3/app-settings/site-url-setting
    *        description: Update site url setting
@@ -324,7 +324,7 @@ module.exports = (crowi) => {
    *
    *    /_api/v3/app-settings/mail-setting:
    *      put:
-   *        tags: [AppSettings, apiv3]
+   *        tags: [AppSettings]
    *        operationId: updateAppSettingMailSetting
    *        summary: /_api/v3/app-settings/site-url-setting
    *        description: Update mail setting
@@ -386,7 +386,7 @@ module.exports = (crowi) => {
    *
    *    /_api/v3/app-settings/aws-setting:
    *      put:
-   *        tags: [AppSettings, apiv3]
+   *        tags: [AppSettings]
    *        operationId: updateAppSettingAwsSetting
    *        summary: /_api/v3/app-settings/aws-setting
    *        description: Update aws setting
@@ -437,7 +437,7 @@ module.exports = (crowi) => {
    *
    *    /_api/v3/app-settings/plugin-setting:
    *      put:
-   *        tags: [AppSettings, apiv3]
+   *        tags: [AppSettings]
    *        operationId: updateAppSettingPluginSetting
    *        summary: /_api/v3/app-settings/plugin-setting
    *        description: Update plugin setting

+ 9 - 9
src/server/routes/apiv3/customize-setting.js

@@ -133,7 +133,7 @@ module.exports = (crowi) => {
    *
    *    /_api/v3/customize-setting:
    *      get:
-   *        tags: [CustomizeSetting, apiv3]
+   *        tags: [CustomizeSetting]
    *        operationId: getCustomizeSetting
    *        summary: /_api/v3/customize-setting
    *        description: Get customize parameters
@@ -175,7 +175,7 @@ module.exports = (crowi) => {
    *
    *    /_api/v3/customize-setting/layoutTheme:
    *      put:
-   *        tags: [CustomizeSetting, apiv3]
+   *        tags: [CustomizeSetting]
    *        operationId: updateLayoutThemeCustomizeSetting
    *        summary: /_api/v3/customize-setting/layoutTheme
    *        description: Update layout and theme
@@ -219,7 +219,7 @@ module.exports = (crowi) => {
    *
    *    /_api/v3/customize-setting/behavior:
    *      put:
-   *        tags: [CustomizeSetting, apiv3]
+   *        tags: [CustomizeSetting]
    *        operationId: updateBehaviorCustomizeSetting
    *        summary: /_api/v3/customize-setting/behavior
    *        description: Update behavior
@@ -261,7 +261,7 @@ module.exports = (crowi) => {
    *
    *    /_api/v3/customize-setting/function:
    *      put:
-   *        tags: [CustomizeSetting, apiv3]
+   *        tags: [CustomizeSetting]
    *        operationId: updateFunctionCustomizeSetting
    *        summary: /_api/v3/customize-setting/function
    *        description: Update function
@@ -311,7 +311,7 @@ module.exports = (crowi) => {
    *
    *    /_api/v3/customize-setting/highlight:
    *      put:
-   *        tags: [CustomizeSetting, apiv3]
+   *        tags: [CustomizeSetting]
    *        operationId: updateHighlightCustomizeSetting
    *        summary: /_api/v3/customize-setting/highlight
    *        description: Update highlight
@@ -355,7 +355,7 @@ module.exports = (crowi) => {
    *
    *    /_api/v3/customize-setting/customizeTitle:
    *      put:
-   *        tags: [CustomizeSetting, apiv3]
+   *        tags: [CustomizeSetting]
    *        operationId: updateCustomizeTitleCustomizeSetting
    *        summary: /_api/v3/customize-setting/customizeTitle
    *        description: Update customizeTitle
@@ -398,7 +398,7 @@ module.exports = (crowi) => {
    *
    *    /_api/v3/customize-setting/customizeHeader:
    *      put:
-   *        tags: [CustomizeSetting, apiv3]
+   *        tags: [CustomizeSetting]
    *        operationId: updateCustomizeHeaderCustomizeSetting
    *        summary: /_api/v3/customize-setting/customizeHeader
    *        description: Update customizeHeader
@@ -439,7 +439,7 @@ module.exports = (crowi) => {
    *
    *    /_api/v3/customize-setting/customizeCss:
    *      put:
-   *        tags: [CustomizeSetting, apiv3]
+   *        tags: [CustomizeSetting]
    *        operationId: updateCustomizeCssCustomizeSetting
    *        summary: /_api/v3/customize-setting/customizeCss
    *        description: Update customizeCss
@@ -481,7 +481,7 @@ module.exports = (crowi) => {
    *
    *    /_api/v3/customize-setting/customizeScript:
    *      put:
-   *        tags: [CustomizeSetting, apiv3]
+   *        tags: [CustomizeSetting]
    *        operationId: updateCustomizeScriptCustomizeSetting
    *        summary: /_api/v3/customize-setting/customizeScript
    *        description: Update customizeScript

+ 3 - 3
src/server/routes/apiv3/export.js

@@ -64,7 +64,7 @@ module.exports = (crowi) => {
    *
    *  /_api/v3/export/status:
    *    get:
-   *      tags: [Export, apiv3]
+   *      tags: [Export]
    *      operationId: getExportStatus
    *      summary: /_api/v3/export/status
    *      description: get properties of stored zip files for export
@@ -93,7 +93,7 @@ module.exports = (crowi) => {
    *
    *  /_api/v3/export:
    *    post:
-   *      tags: [Export, apiv3]
+   *      tags: [Export]
    *      operationId: createExport
    *      summary: /_api/v3/export
    *      description: generate zipped jsons for collections
@@ -131,7 +131,7 @@ module.exports = (crowi) => {
    *
    *  /_api/v3/export/{fileName}:
    *    delete:
-   *      tags: [Export, apiv3]
+   *      tags: [Export]
    *      operationId: deleteExport
    *      summary: /_api/v3/export/{fileName}
    *      description: delete the file

+ 1 - 1
src/server/routes/apiv3/healthcheck.js

@@ -20,7 +20,7 @@ module.exports = (crowi) => {
    *
    *  /_api/v3/healthcheck:
    *    get:
-   *      tags: [Healthcheck, apiv3]
+   *      tags: [Healthcheck]
    *      operationId: getHealthcheck
    *      summary: /_api/v3/healthcheck
    *      description: Check whether the server is healthy or not

+ 4 - 4
src/server/routes/apiv3/import.js

@@ -103,7 +103,7 @@ module.exports = (crowi) => {
    *
    *  /_api/v3/import/status:
    *    get:
-   *      tags: [Import, apiv3]
+   *      tags: [Import]
    *      operationId: getImportStatus
    *      summary: /_api/v3/import/status
    *      description: Get properties of stored zip files for import
@@ -132,7 +132,7 @@ module.exports = (crowi) => {
    *
    *  /_api/v3/import:
    *    post:
-   *      tags: [Import, apiv3]
+   *      tags: [Import]
    *      operationId: executeImport
    *      summary: /_api/v3/import
    *      description: import a collection from a zipped json
@@ -243,7 +243,7 @@ module.exports = (crowi) => {
    *
    *  /_api/v3/import/upload:
    *    post:
-   *      tags: [Import, apiv3]
+   *      tags: [Import]
    *      operationId: uploadImport
    *      summary: /_api/v3/import/upload
    *      description: upload a zip file
@@ -290,7 +290,7 @@ module.exports = (crowi) => {
    *
    *  /_api/v3/import/all:
    *    delete:
-   *      tags: [Import, apiv3]
+   *      tags: [Import]
    *      operationId: deleteImportAll
    *      summary: /_api/v3/import/all
    *      description: Delete all zip files

+ 4 - 4
src/server/routes/apiv3/markdown-setting.js

@@ -94,7 +94,7 @@ module.exports = (crowi) => {
    *
    *    /_api/v3/markdown-setting:
    *      get:
-   *        tags: [MarkDownSetting, apiv3]
+   *        tags: [MarkDownSetting]
    *        operationId: getMarkdownSetting
    *        summary: /_api/v3/markdown-setting
    *        description: Get markdown parameters
@@ -129,7 +129,7 @@ module.exports = (crowi) => {
    *
    *    /_api/v3/markdown-setting/lineBreak:
    *      put:
-   *        tags: [MarkDownSetting, apiv3]
+   *        tags: [MarkDownSetting]
    *        operationId: updateLineBreakMarkdownSetting
    *        summary: /_api/v3/markdown-setting/lineBreak
    *        description: Update lineBreak setting
@@ -175,7 +175,7 @@ module.exports = (crowi) => {
    *
    *    /_api/v3/markdown-setting/presentation:
    *      put:
-   *        tags: [MarkDownSetting, apiv3]
+   *        tags: [MarkDownSetting]
    *        operationId: updatePresentationMarkdownSetting
    *        summary: /_api/v3/markdown-setting/presentation
    *        description: Update presentation
@@ -224,7 +224,7 @@ module.exports = (crowi) => {
    *
    *    /_api/v3/markdown-setting/xss:
    *      put:
-   *        tags: [MarkDownSetting, apiv3]
+   *        tags: [MarkDownSetting]
    *        operationId: updateXssMarkdownSetting
    *        summary: /_api/v3/markdown-setting/xss
    *        description: Update xss

+ 1 - 1
src/server/routes/apiv3/mongo.js

@@ -19,7 +19,7 @@ module.exports = (crowi) => {
    *
    *  /_api/v3/mongo/collections:
    *    get:
-   *      tags: [Mongo, apiv3]
+   *      tags: [Mongo]
    *      operationId: getMongoCollections
    *      summary: /_api/v3/mongo/collections
    *      description: get mongodb collections names

+ 1 - 1
src/server/routes/apiv3/statistics.js

@@ -85,7 +85,7 @@ module.exports = (crowi) => {
    *
    *  /_api/v3/statistics/user:
    *    get:
-   *      tags: [Statistics, apiv3]
+   *      tags: [Statistics]
    *      operationId: getStatisticsUser
    *      summary: /_api/v3/statistics/user
    *      description: Get statistics for user

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

@@ -25,7 +25,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /_api/v3/user-group-relations:
    *      get:
-   *        tags: [UserGroupRelation, apiv3]
+   *        tags: [UserGroupRelation]
    *        operationId: listUserGroupRelations
    *        summary: /_api/v3/user-group-relations
    *        description: Gets the user group relations

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

@@ -45,7 +45,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /_api/v3/user-groups:
    *      get:
-   *        tags: [UserGroup, apiv3]
+   *        tags: [UserGroup]
    *        operationId: getUserGroup
    *        summary: /_api/v3/user-groups
    *        description: Get usergroups
@@ -85,7 +85,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /_api/v3/user-groups:
    *      post:
-   *        tags: [UserGroup, apiv3]
+   *        tags: [UserGroup]
    *        operationId: createUserGroup
    *        summary: /_api/v3/user-groups
    *        description: Adds userGroup
@@ -137,7 +137,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /_api/v3/user-groups/{id}:
    *      delete:
-   *        tags: [UserGroup, apiv3]
+   *        tags: [UserGroup]
    *        operationId: deleteUserGroup
    *        summary: /_api/v3/user-groups/{id}
    *        description: Deletes userGroup
@@ -199,7 +199,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /_api/v3/user-groups/{id}:
    *      put:
-   *        tags: [UserGroup, apiv3]
+   *        tags: [UserGroup]
    *        operationId: updateUserGroups
    *        summary: /_api/v3/user-groups/{id}
    *        description: Update userGroup
@@ -256,7 +256,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /_api/v3/user-groups/{id}/users:
    *      get:
-   *        tags: [UserGroup, apiv3]
+   *        tags: [UserGroup]
    *        operationId: getUsersUserGroups
    *        summary: /_api/v3/user-groups/{id}/users
    *        description: Get users related to the userGroup
@@ -306,7 +306,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /_api/v3/user-groups/{id}/unrelated-users:
    *      get:
-   *        tags: [UserGroup, apiv3]
+   *        tags: [UserGroup]
    *        operationId: getUnrelatedUsersUserGroups
    *        summary: /_api/v3/user-groups/{id}/unrelated-users
    *        description: Get users unrelated to the userGroup
@@ -364,7 +364,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /_api/v3/user-groups/{id}/users:
    *      post:
-   *        tags: [UserGroup, apiv3]
+   *        tags: [UserGroup]
    *        operationId: addUserUserGroups
    *        summary: /_api/v3/user-groups/{id}/users
    *        description: Add a user to the userGroup
@@ -433,7 +433,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /_api/v3/user-groups/{id}/users:
    *      delete:
-   *        tags: [UserGroup, apiv3]
+   *        tags: [UserGroup]
    *        operationId: deleteUsersUserGroups
    *        summary: /_api/v3/user-groups/{id}/users
    *        description: remove a user from the userGroup
@@ -495,7 +495,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /_api/v3/user-groups/{id}/user-group-relations:
    *      get:
-   *        tags: [UserGroup, apiv3]
+   *        tags: [UserGroup]
    *        operationId: getUserGroupRelationsUserGroups
    *        summary: /_api/v3/user-groups/{id}/user-group-relations
    *        description: Get the user group relations for the userGroup
@@ -549,7 +549,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /_api/v3/user-groups/{id}/pages:
    *      get:
-   *        tags: [UserGroup, apiv3]
+   *        tags: [UserGroup]
    *        operationId: getPagesUserGroups
    *        summary: /_api/v3/user-groups/{id}/pages
    *        description: Get closed pages for the userGroup

+ 9 - 9
src/server/routes/apiv3/users.js

@@ -83,7 +83,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /_api/v3/users:
    *      get:
-   *        tags: [Users, apiv3]
+   *        tags: [Users]
    *        operationId: listUsers
    *        summary: /_api/v3/users
    *        description: Get users
@@ -135,7 +135,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /_api/v3/users/invite:
    *      post:
-   *        tags: [Users, apiv3]
+   *        tags: [Users]
    *        operationId: inviteUser
    *        summary: /_api/v3/users/invite
    *        description: Create new users and send Emails
@@ -180,7 +180,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /_api/v3/users/{id}/giveAdmin:
    *      put:
-   *        tags: [Users, apiv3]
+   *        tags: [Users]
    *        operationId: giveAdminUser
    *        summary: /_api/v3/users/{id}/giveAdmin
    *        description: Give user admin
@@ -221,7 +221,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /_api/v3/users/{id}/removeAdmin:
    *      put:
-   *        tags: [Users, apiv3]
+   *        tags: [Users]
    *        operationId: removeAdminUser
    *        summary: /_api/v3/users/{id}/removeAdmin
    *        description: Remove user admin
@@ -262,7 +262,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /_api/v3/users/{id}/activate:
    *      put:
-   *        tags: [Users, apiv3]
+   *        tags: [Users]
    *        operationId: activateUser
    *        summary: /_api/v3/users/{id}/activate
    *        description: Activate user
@@ -311,7 +311,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /_api/v3/users/{id}/deactivate:
    *      put:
-   *        tags: [Users, apiv3]
+   *        tags: [Users]
    *        operationId: deactivateUser
    *        summary: /_api/v3/users/{id}/deactivate
    *        description: Deactivate user
@@ -352,7 +352,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /_api/v3/users/{id}/remove:
    *      delete:
-   *        tags: [Users, apiv3]
+   *        tags: [Users]
    *        operationId: removeUser
    *        summary: /_api/v3/users/{id}/remove
    *        description: Delete user
@@ -397,7 +397,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /_api/v3/users/external-accounts:
    *      get:
-   *        tags: [Users, apiv3]
+   *        tags: [Users]
    *        operationId: listExternalAccountsUsers
    *        summary: /_api/v3/users/external-accounts
    *        description: Get external-account
@@ -431,7 +431,7 @@ module.exports = (crowi) => {
    *  paths:
    *    /_api/v3/users/external-accounts/{id}/remove:
    *      delete:
-   *        tags: [Users, apiv3]
+   *        tags: [Users]
    *        operationId: removeExternalAccountUser
    *        summary: /_api/v3/users/external-accounts/{id}/remove
    *        description: Delete ExternalAccount