Przeglądaj źródła

add operationId, description

Ryu Sato 6 lat temu
rodzic
commit
e47d5df82d

+ 4 - 0
src/server/routes/attachment.js

@@ -250,6 +250,7 @@ module.exports = function(crowi, app) {
    *    /_api/attachments.list:
    *      get:
    *        tags: [Attachments]
+   *        operationId: /_api/attachments.list
    *        summary: /_api/attachments.list
    *        description: Get list of attachments in page
    *        parameters:
@@ -317,6 +318,7 @@ module.exports = function(crowi, app) {
    *    components:
    *      schemas:
    *        AttachmentAddParams:
+   *          description: AttachmentAddParams
    *          type: object
    *          properties:
    *            page_id:
@@ -337,6 +339,7 @@ module.exports = function(crowi, app) {
    *    /_api/attachments.add:
    *      post:
    *        tags: [Attachments]
+   *        operationId: /_api/attachments.add
    *        summary: /_api/attachments.add
    *        description: Add attachment to the page
    *        requestBody:
@@ -483,6 +486,7 @@ module.exports = function(crowi, app) {
    *    /_api/attachments.remove:
    *      post:
    *        tags: [Attachments]
+   *        operationId: /_api/attachments.remove
    *        summary: /_api/attachments.remove
    *        description: Remove attachment
    *        requestBody:

+ 4 - 0
src/server/routes/bookmark.js

@@ -46,6 +46,7 @@ module.exports = function(crowi, app) {
    *    /_api/bookmarks.get:
    *      get:
    *        tags: [Bookmarks]
+   *        operationId: /_api/bookmarks.get
    *        summary: /_api/bookmarks.get
    *        description: Get bookmark of the page with the user
    *        parameters:
@@ -100,6 +101,7 @@ module.exports = function(crowi, app) {
    *    /_api/bookmarks.list:
    *      get:
    *        tags: [Bookmarks]
+   *        operationId: /_api/bookmarks.list
    *        summary: /_api/bookmarks.list
    *        description: Get bookmark list of the page with the user
    *        parameters:
@@ -150,6 +152,7 @@ module.exports = function(crowi, app) {
    *    /_api/bookmarks.add:
    *      post:
    *        tags: [Bookmarks]
+   *        operationId: /_api/bookmarks.add
    *        summary: /_api/bookmarks.add
    *        description: Add bookmark of the page
    *        parameters:
@@ -204,6 +207,7 @@ module.exports = function(crowi, app) {
    *    /_api/bookmarks.remove:
    *      post:
    *        tags: [Bookmarks]
+   *        operationId: /_api/bookmarks.remove
    *        summary: /_api/bookmarks.remove
    *        description: Remove bookmark of the page
    *        requestBody:

+ 4 - 0
src/server/routes/comment.js

@@ -65,6 +65,7 @@
    *    /_api/comments.get:
    *      get:
    *        tags: [Comments]
+   *        operationId: /_api/comments.get
    *        summary: /_api/comments.get
    *        description: Get comments of the page of the revision
    *        parameters:
@@ -158,6 +159,7 @@
    *    /_api/comments.add:
    *      post:
    *        tags: [Comments]
+   *        operationId: /_api/comments.add
    *        summary: /_api/comments.add
    *        description: Post comment for the page
    *        requestBody:
@@ -286,6 +288,7 @@
    *    /_api/comments.update:
    *      post:
    *        tags: [Comments]
+   *        operationId: /_api/comments.update
    *        summary: /_api/comments.update
    *        description: Update comment dody
    *        requestBody:
@@ -377,6 +380,7 @@
    *    /_api/comments.remove:
    *      post:
    *        tags: [Comments]
+   *        operationId: /_api/comments.remove
    *        summary: /_api/comments.remove
    *        description: Remove specified comment
    *        requestBody:

+ 12 - 0
src/server/routes/page.js

@@ -648,6 +648,7 @@ module.exports = function(crowi, app) {
    *    /_api/pages.list:
    *      get:
    *        tags: [Pages]
+   *        operationId: /_api/pages.list
    *        summary: /_api/pages.list
    *        description: Get list of pages
    *        parameters:
@@ -737,6 +738,7 @@ module.exports = function(crowi, app) {
    *    /_api/pages.create:
    *      post:
    *        tags: [Pages]
+   *        operationId: /_api/pages.create
    *        summary: /_api/pages.create
    *        description: Create page
    *        requestBody:
@@ -845,6 +847,7 @@ module.exports = function(crowi, app) {
    *    /_api/pages.update:
    *      post:
    *        tags: [Pages]
+   *        operationId: /_api/pages.update
    *        summary: /_api/pages.update
    *        description: Update page
    *        requestBody:
@@ -972,6 +975,7 @@ module.exports = function(crowi, app) {
    *    /_api/pages.get:
    *      get:
    *        tags: [Pages]
+   *        operationId: /_api/pages.get
    *        summary: /_api/pages.get
    *        description: Get page data
    *        parameters:
@@ -1095,6 +1099,7 @@ module.exports = function(crowi, app) {
    *    /_api/pages.seen:
    *      post:
    *        tags: [Pages]
+   *        operationId: /_api/pages.seen
    *        summary: /_api/pages.seen
    *        description: Mark as seen user
    *        requestBody:
@@ -1163,6 +1168,7 @@ module.exports = function(crowi, app) {
    *    /_api/likes.add:
    *      post:
    *        tags: [Pages]
+   *        operationId: /_api/likes.add
    *        summary: /_api/likes.add
    *        description: Like page
    *        requestBody:
@@ -1238,6 +1244,7 @@ module.exports = function(crowi, app) {
    *    /_api/likes.remove:
    *      post:
    *        tags: [Pages]
+   *        operationId: /_api/likes.remove
    *        summary: /_api/likes.remove
    *        description: Unlike page
    *        requestBody:
@@ -1305,6 +1312,7 @@ module.exports = function(crowi, app) {
    *    /_api/pages.updatePost:
    *      get:
    *        tags: [Pages]
+   *        operationId: /_api/pages.updatePost
    *        summary: /_api/pages.updatePost
    *        description: Get UpdatePost setting list
    *        parameters:
@@ -1365,6 +1373,7 @@ module.exports = function(crowi, app) {
    *    /_api/pages.remove:
    *      post:
    *        tags: [Pages]
+   *        operationId: /_api/pages.remove
    *        summary: /_api/pages.remov
    *        description: Remove page
    *        requestBody:
@@ -1468,6 +1477,7 @@ module.exports = function(crowi, app) {
    *    /_api/pages.revertRemove:
    *      post:
    *        tags: [Pages]
+   *        operationId: /_api/pages.revertRemove
    *        summary: /_api/pages.revertRemove
    *        description: Revert removed page
    *        requestBody:
@@ -1540,6 +1550,7 @@ module.exports = function(crowi, app) {
    *    /_api/pages.rename:
    *      post:
    *        tags: [Pages]
+   *        operationId: /_api/pages.rename
    *        summary: /_api/pages.rename
    *        description: Rename page
    *        requestBody:
@@ -1691,6 +1702,7 @@ module.exports = function(crowi, app) {
    *    /_api/pages.unlink:
    *      post:
    *        tags: [Pages]
+   *        operationId: /_api/pages.unlink
    *        summary: /_api/pages.unlink
    *        description: Remove the redirecting page
    *        requestBody:

+ 3 - 0
src/server/routes/revision.js

@@ -61,6 +61,7 @@ module.exports = function(crowi, app) {
    *    /_api/revisions.get:
    *      get:
    *        tags: [Revisions]
+   *        operationId: /_api/revisions.get
    *        summary: /_api/revisions.get
    *        description: Get revision
    *        parameters:
@@ -128,6 +129,7 @@ module.exports = function(crowi, app) {
    *    /_api/revisions.ids:
    *      get:
    *        tags: [Revisions]
+   *        operationId: /_api/revisions.ids
    *        summary: /_api/revisions.ids
    *        description: Get revision id list of the page
    *        parameters:
@@ -188,6 +190,7 @@ module.exports = function(crowi, app) {
    *    /_api/revisions.list:
    *      get:
    *        tags: [Revisions]
+   *        operationId: /_api/revisions.list
    *        summary: /_api/revisions.list
    *        description: Get revisions
    *        parameters: