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

remove base path from API reference

Ryu Sato 6 лет назад
Родитель
Сommit
120d2ec3cf

+ 12 - 12
src/server/routes/attachment.js

@@ -308,11 +308,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/attachments.list:
+   *    /attachments.list:
    *      get:
    *        tags: [Attachments, CrowiCompatibles]
    *        operationId: listAttachments
-   *        summary: /_api/attachments.list
+   *        summary: /attachments.list
    *        description: Get list of attachments in page
    *        parameters:
    *          - in: query
@@ -366,11 +366,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/attachments.limit:
+   *    /attachments.limit:
    *      get:
    *        tags: [Attachments]
    *        operationId: getAttachmentsLimit
-   *        summary: /_api/attachments.limit
+   *        summary: /attachments.limit
    *        description: Get available capacity of uploaded file with GridFS
    *        parameters:
    *          - in: query
@@ -411,11 +411,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/attachments.add:
+   *    /attachments.add:
    *      post:
    *        tags: [Attachments, CrowiCompatibles]
    *        operationId: addAttachment
-   *        summary: /_api/attachments.add
+   *        summary: /attachments.add
    *        description: Add attachment to the page
    *        requestBody:
    *          content:
@@ -537,11 +537,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/attachments.uploadProfileImage:
+   *    /attachments.uploadProfileImage:
    *      post:
    *        tags: [Attachments]
    *        operationId: uploadProfileImage
-   *        summary: /_api/attachments.uploadProfileImage
+   *        summary: /attachments.uploadProfileImage
    *        description: Upload profile image
    *        requestBody:
    *          content:
@@ -632,11 +632,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/attachments.remove:
+   *    /attachments.remove:
    *      post:
    *        tags: [Attachments, CrowiCompatibles]
    *        operationId: removeAttachment
-   *        summary: /_api/attachments.remove
+   *        summary: /attachments.remove
    *        description: Remove attachment
    *        requestBody:
    *          content:
@@ -696,11 +696,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/attachments.removeProfileImage:
+   *    /attachments.removeProfileImage:
    *      post:
    *        tags: [Attachments]
    *        operationId: removeProfileImage
-   *        summary: /_api/attachments.removeProfileImage
+   *        summary: /attachments.removeProfileImage
    *        description: Remove profile image
    *        requestBody:
    *          content:

+ 6 - 6
src/server/routes/bookmark.js

@@ -43,11 +43,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/bookmarks.get:
+   *    /bookmarks.get:
    *      get:
    *        tags: [Bookmarks, CrowiCompatibles]
    *        operationId: getBookmark
-   *        summary: /_api/bookmarks.get
+   *        summary: /bookmarks.get
    *        description: Get bookmark of the page with the user
    *        parameters:
    *          - in: query
@@ -110,11 +110,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/bookmarks.add:
+   *    /bookmarks.add:
    *      post:
    *        tags: [Bookmarks, CrowiCompatibles]
    *        operationId: addBookmark
-   *        summary: /_api/bookmarks.add
+   *        summary: /bookmarks.add
    *        description: Add bookmark of the page
    *        parameters:
    *          - in: query
@@ -165,11 +165,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/bookmarks.remove:
+   *    /bookmarks.remove:
    *      post:
    *        tags: [Bookmarks, CrowiCompatibles]
    *        operationId: removeBookmark
-   *        summary: /_api/bookmarks.remove
+   *        summary: /bookmarks.remove
    *        description: Remove bookmark of the page
    *        requestBody:
    *          content:

+ 8 - 8
src/server/routes/comment.js

@@ -62,11 +62,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/comments.get:
+   *    /comments.get:
    *      get:
    *        tags: [Comments, CrowiCompatibles]
    *        operationId: getComments
-   *        summary: /_api/comments.get
+   *        summary: /comments.get
    *        description: Get comments of the page of the revision
    *        parameters:
    *          - in: query
@@ -156,11 +156,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/comments.add:
+   *    /comments.add:
    *      post:
    *        tags: [Comments, CrowiCompatibles]
    *        operationId: addComment
-   *        summary: /_api/comments.add
+   *        summary: /comments.add
    *        description: Post comment for the page
    *        requestBody:
    *          content:
@@ -285,11 +285,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/comments.update:
+   *    /comments.update:
    *      post:
    *        tags: [Comments, CrowiCompatibles]
    *        operationId: updateComment
-   *        summary: /_api/comments.update
+   *        summary: /comments.update
    *        description: Update comment dody
    *        requestBody:
    *          content:
@@ -377,11 +377,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/comments.remove:
+   *    /comments.remove:
    *      post:
    *        tags: [Comments, CrowiCompatibles]
    *        operationId: removeComment
-   *        summary: /_api/comments.remove
+   *        summary: /comments.remove
    *        description: Remove specified comment
    *        requestBody:
    *          content:

+ 6 - 6
src/server/routes/hackmd.js

@@ -128,11 +128,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/hackmd.integrate:
+   *    /hackmd.integrate:
    *      post:
    *        tags: [Hackmd]
    *        operationId: integrateHackmd
-   *        summary: /_api/hackmd.integrate
+   *        summary: /hackmd.integrate
    *        description: Integrate hackmd
    *        requestBody:
    *          content:
@@ -241,11 +241,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/hackmd.discard:
+   *    /hackmd.discard:
    *      post:
    *        tags: [Hackmd]
    *        operationId: discardHackmd
-   *        summary: /_api/hackmd.discard
+   *        summary: /hackmd.discard
    *        description: Discard hackmd
    *        requestBody:
    *          content:
@@ -305,11 +305,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/hackmd.saveOnHackmd:
+   *    /hackmd.saveOnHackmd:
    *      post:
    *        tags: [Hackmd]
    *        operationId: saveOnHackmd
-   *        summary: /_api/hackmd.saveOnHackmd
+   *        summary: /hackmd.saveOnHackmd
    *        description: Receive when save operation triggered on HackMD
    *        requestBody:
    *          content:

+ 2 - 2
src/server/routes/me.js

@@ -67,11 +67,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *   /_api/me/user-group-relations:
+   *   /me/user-group-relations:
    *     get:
    *       tags: [Me, CrowiCompatibles]
    *       operationId: getUserGroupRelations
-   *       summary: /_api/me/user-group-relations
+   *       summary: /me/user-group-relations
    *       description: Get user group relations
    *       responses:
    *         200:

+ 26 - 26
src/server/routes/page.js

@@ -645,11 +645,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/pages.list:
+   *    /pages.list:
    *      get:
    *        tags: [Pages, CrowiCompatibles]
    *        operationId: listPages
-   *        summary: /_api/pages.list
+   *        summary: /pages.list
    *        description: Get list of pages
    *        parameters:
    *          - in: query
@@ -739,11 +739,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/pages.create:
+   *    /pages.create:
    *      post:
    *        tags: [Pages, CrowiCompatibles]
    *        operationId: createPage
-   *        summary: /_api/pages.create
+   *        summary: /pages.create
    *        description: Create page
    *        requestBody:
    *          content:
@@ -848,11 +848,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/pages.update:
+   *    /pages.update:
    *      post:
    *        tags: [Pages, CrowiCompatibles]
    *        operationId: updatePage
-   *        summary: /_api/pages.update
+   *        summary: /pages.update
    *        description: Update page
    *        requestBody:
    *          content:
@@ -976,11 +976,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/pages.get:
+   *    /pages.get:
    *      get:
    *        tags: [Pages, CrowiCompatibles]
    *        operationId: getPage
-   *        summary: /_api/pages.get
+   *        summary: /pages.get
    *        description: Get page data
    *        parameters:
    *          - in: query
@@ -1059,11 +1059,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/pages.exist:
+   *    /pages.exist:
    *      get:
    *        tags: [Pages]
    *        operationId: getPageExistence
-   *        summary: /_api/pages.exist
+   *        summary: /pages.exist
    *        description: Get page existence
    *        parameters:
    *          - in: query
@@ -1116,11 +1116,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/pages.getPageTag:
+   *    /pages.getPageTag:
    *      get:
    *        tags: [Pages]
    *        operationId: getPageTag
-   *        summary: /_api/pages.getPageTag
+   *        summary: /pages.getPageTag
    *        description: Get page tag
    *        parameters:
    *          - in: query
@@ -1164,11 +1164,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/pages.seen:
+   *    /pages.seen:
    *      post:
    *        tags: [Pages, CrowiCompatibles]
    *        operationId: seenPage
-   *        summary: /_api/pages.seen
+   *        summary: /pages.seen
    *        description: Mark as seen user
    *        requestBody:
    *          content:
@@ -1233,11 +1233,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/likes.add:
+   *    /likes.add:
    *      post:
    *        tags: [Likes, CrowiCompatibles]
    *        operationId: addLike
-   *        summary: /_api/likes.add
+   *        summary: /likes.add
    *        description: Like page
    *        requestBody:
    *          content:
@@ -1309,11 +1309,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/likes.remove:
+   *    /likes.remove:
    *      post:
    *        tags: [Likes, CrowiCompatibles]
    *        operationId: removeLike
-   *        summary: /_api/likes.remove
+   *        summary: /likes.remove
    *        description: Unlike page
    *        requestBody:
    *          content:
@@ -1377,11 +1377,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/pages.updatePost:
+   *    /pages.updatePost:
    *      get:
    *        tags: [Pages, CrowiCompatibles]
    *        operationId: getUpdatePostPage
-   *        summary: /_api/pages.updatePost
+   *        summary: /pages.updatePost
    *        description: Get UpdatePost setting list
    *        parameters:
    *          - in: query
@@ -1545,11 +1545,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/pages.rename:
+   *    /pages.rename:
    *      post:
    *        tags: [Pages, CrowiCompatibles]
    *        operationId: renamePage
-   *        summary: /_api/pages.rename
+   *        summary: /pages.rename
    *        description: Rename page
    *        requestBody:
    *          content:
@@ -1663,11 +1663,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/pages.duplicate:
+   *    /pages.duplicate:
    *      post:
    *        tags: [Pages]
    *        operationId: duplicatePage
-   *        summary: /_api/pages.duplicate
+   *        summary: /pages.duplicate
    *        description: Duplicate page
    *        requestBody:
    *          content:
@@ -1759,11 +1759,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/pages.recentCreated:
+   *    /pages.recentCreated:
    *      get:
    *        tags: [Pages]
    *        operationId: getRecentCreatedPages
-   *        summary: /_api/pages.recentCreated
+   *        summary: /pages.recentCreated
    *        description: Get recent created page list
    *        parameters:
    *          - in: query

+ 9 - 9
src/server/routes/revision.js

@@ -58,11 +58,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/revisions.get:
+   *    /revisions.get:
    *      get:
    *        tags: [Revisions, CrowiCompatibles]
-   *        operationId: /_api/revisions.get
-   *        summary: /_api/revisions.get
+   *        operationId: revisions.get
+   *        summary: /revisions.get
    *        description: Get revision
    *        parameters:
    *          - in: query
@@ -126,11 +126,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/revisions.ids:
+   *    /revisions.ids:
    *      get:
    *        tags: [Revisions, CrowiCompatibles]
-   *        operationId: /_api/revisions.ids
-   *        summary: /_api/revisions.ids
+   *        operationId: revisions.ids
+   *        summary: /revisions.ids
    *        description: Get revision id list of the page
    *        parameters:
    *          - in: query
@@ -187,11 +187,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/revisions.list:
+   *    /revisions.list:
    *      get:
    *        tags: [Revisions, CrowiCompatibles]
-   *        operationId: /_api/revisions.list
-   *        summary: /_api/revisions.list
+   *        operationId: revisions.list
+   *        summary: /revisions.list
    *        description: Get revisions
    *        parameters:
    *          - in: query

+ 2 - 2
src/server/routes/search.js

@@ -48,11 +48,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *   /_api/search:
+   *   /search:
    *     get:
    *       tags: [Search, CrowiCompatibles]
    *       operationId: searchPages
-   *       summary: /_api/search
+   *       summary: /search
    *       description: Search pages
    *       parameters:
    *         - in: query

+ 6 - 6
src/server/routes/tag.js

@@ -44,11 +44,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/tags.search:
+   *    /tags.search:
    *      get:
    *        tags: [Tags]
    *        operationId: searchTags
-   *        summary: /_api/tags.search
+   *        summary: /tags.search
    *        description: Search tags
    *        parameters:
    *          - in: query
@@ -90,11 +90,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/tags.update:
+   *    /tags.update:
    *      post:
    *        tags: [Tags]
    *        operationId: updateTag
-   *        summary: /_api/tags.update
+   *        summary: /tags.update
    *        description: Update tag
    *        requestBody:
    *          content:
@@ -154,11 +154,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/tags.list:
+   *    /tags.list:
    *      get:
    *        tags: [Tags]
    *        operationId: listTags
-   *        summary: /_api/tags.list
+   *        summary: /tags.list
    *        description: Get tags
    *        parameters:
    *          - in: query

+ 2 - 2
src/server/routes/user.js

@@ -86,11 +86,11 @@ module.exports = function(crowi, app) {
   /**
    * @swagger
    *
-   *    /_api/users.list:
+   *    /users.list:
    *      get:
    *        tags: [Users, CrowiCompatibles]
    *        operationId: listUsersV1
-   *        summary: /_api/users.list
+   *        summary: /users.list
    *        description: Get list of users
    *        parameters:
    *          - in: query