{ "opencollection": "1.0.0", "info": { "name": "APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Comments API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Comments", "type": "folder" }, "items": [ { "info": { "name": "APIs.io Engineering Platform Get an API's comments", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/apis/:apiId/comments", "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The API's ID." } ] }, "docs": "Gets all comments left by users in an API." }, { "info": { "name": "APIs.io Engineering Platform Create an API comment", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/apis/:apiId/comments", "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The API's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a comment on an API.\n\n**Note:**\n\nThis endpoint accepts a max of 10,000 characters.\n" }, { "info": { "name": "APIs.io Engineering Platform Update an API's comment", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/apis/:apiId/comments/:commentId", "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The API's ID." }, { "name": "commentId", "value": "", "type": "path", "description": "The comment's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a comment on an API.\n\n**Note:**\n\nThis endpoint accepts a max of 10,000 characters.\n" }, { "info": { "name": "APIs.io Engineering Platform Delete an API's comment", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/apis/:apiId/comments/:commentId", "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The API's ID." }, { "name": "commentId", "value": "", "type": "path", "description": "The comment's ID." } ] }, "docs": "Deletes a comment from an API. On success, this returns an HTTP `204 No Content` response.\n\n**Note:**\n\nDeleting the first comment of a thread deletes all the comments in the thread.\n" }, { "info": { "name": "APIs.io Engineering Platform Get a collection's comments", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/comments", "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "The collection's unique ID." } ] }, "docs": "Gets all comments left by users in a collection." }, { "info": { "name": "APIs.io Engineering Platform Create a collection comment", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/comments", "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "The collection's unique ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a comment on a collection.\n\n**Note:**\n\nThis endpoint accepts a max of 10,000 characters.\n" }, { "info": { "name": "APIs.io Engineering Platform Update a collection's comment", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/comments/:commentId", "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "The collection's unique ID." }, { "name": "commentId", "value": "", "type": "path", "description": "The comment's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a comment on a collection.\n\n**Note:**\n\nThis endpoint accepts a max of 10,000 characters.\n" }, { "info": { "name": "APIs.io Engineering Platform Delete a collection's comment", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/comments/:commentId", "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "The collection's unique ID." }, { "name": "commentId", "value": "", "type": "path", "description": "The comment's ID." } ] }, "docs": "Deletes a comment from a collection. On success, this returns an HTTP `204 No Content` response.\n\n**Note:**\n\nDeleting the first comment of a thread deletes all the comments in the thread.\n" }, { "info": { "name": "APIs.io Engineering Platform Get a folder's comments", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/folders/:folderId/comments", "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "The collection's unique ID." }, { "name": "folderId", "value": "", "type": "path", "description": "The folder's unique ID." } ] }, "docs": "Gets all comments left by users in a folder." }, { "info": { "name": "APIs.io Engineering Platform Create a folder comment", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/folders/:folderId/comments", "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "The collection's unique ID." }, { "name": "folderId", "value": "", "type": "path", "description": "The folder's unique ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a comment on a folder.\n\n**Note:**\n\nThis endpoint accepts a max of 10,000 characters.\n" }, { "info": { "name": "APIs.io Engineering Platform Update a folder's comment", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/folders/:folderId/comments/:commentId", "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "The collection's unique ID." }, { "name": "folderId", "value": "", "type": "path", "description": "The folder's unique ID." }, { "name": "commentId", "value": "", "type": "path", "description": "The comment's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a comment on a folder.\n\n**Note:**\n\nThis endpoint accepts a max of 10,000 characters.\n" }, { "info": { "name": "APIs.io Engineering Platform Delete a folder's comment", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/folders/:folderId/comments/:commentId", "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "The collection's unique ID." }, { "name": "folderId", "value": "", "type": "path", "description": "The folder's unique ID." }, { "name": "commentId", "value": "", "type": "path", "description": "The comment's ID." } ] }, "docs": "Deletes a comment from a folder. On success, this returns an HTTP `204 No Content` response.\n\n**Note:**\n\nDeleting the first comment of a thread deletes all the comments in the thread.\n" }, { "info": { "name": "APIs.io Engineering Platform Get a request's comments", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/requests/:requestId/comments", "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "The collection's unique ID." }, { "name": "requestId", "value": "", "type": "path", "description": "The request's unique ID." } ] }, "docs": "Gets all comments left by users in a request." }, { "info": { "name": "APIs.io Engineering Platform Create a request comment", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/requests/:requestId/comments", "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "The collection's unique ID." }, { "name": "requestId", "value": "", "type": "path", "description": "The request's unique ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a comment on a request.\n\n**Note:**\n\nThis endpoint accepts a max of 10,000 characters.\n" }, { "info": { "name": "APIs.io Engineering Platform Update a request's comment", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/requests/:requestId/comments/:commentId", "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "The collection's unique ID." }, { "name": "requestId", "value": "", "type": "path", "description": "The request's unique ID." }, { "name": "commentId", "value": "", "type": "path", "description": "The comment's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a comment on a request.\n\n**Note:**\n\nThis endpoint accepts a max of 10,000 characters.\n" }, { "info": { "name": "APIs.io Engineering Platform Delete a request's comment", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/requests/:requestId/comments/:commentId", "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "The collection's unique ID." }, { "name": "requestId", "value": "", "type": "path", "description": "The request's unique ID." }, { "name": "commentId", "value": "", "type": "path", "description": "The comment's ID." } ] }, "docs": "Deletes a comment from a request. On success, this returns an HTTP `204 No Content` response.\n\n**Note:**\n\nDeleting the first comment of a thread deletes all the comments in the thread.\n" }, { "info": { "name": "APIs.io Engineering Platform Get a response's comments", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/responses/:responseId/comments", "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "The collection's unique ID." }, { "name": "responseId", "value": "", "type": "path", "description": "The response's unique ID." } ] }, "docs": "Gets all comments left by users in a response." }, { "info": { "name": "APIs.io Engineering Platform Create a response comment", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/responses/:responseId/comments", "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "The collection's unique ID." }, { "name": "responseId", "value": "", "type": "path", "description": "The response's unique ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a comment on a response.\n\n**Note:**\n\nThis endpoint accepts a max of 10,000 characters.\n" }, { "info": { "name": "APIs.io Engineering Platform Update a response's comment", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/responses/:responseId/comments/:commentId", "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "The collection's unique ID." }, { "name": "responseId", "value": "", "type": "path", "description": "The response's unique ID." }, { "name": "commentId", "value": "", "type": "path", "description": "The comment's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a comment on a response.\n\n**Note:**\n\nThis endpoint accepts a max of 10,000 characters.\n" }, { "info": { "name": "APIs.io Engineering Platform Delete a response's comment", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/responses/:responseId/comments/:commentId", "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "The collection's unique ID." }, { "name": "responseId", "value": "", "type": "path", "description": "The response's unique ID." }, { "name": "commentId", "value": "", "type": "path", "description": "The comment's ID." } ] }, "docs": "Deletes a comment from a response. On success, this returns an HTTP `204 No Content` response.\n\n**Note:**\n\nDeleting the first comment of a thread deletes all the comments in the thread.\n" }, { "info": { "name": "APIs.io Engineering Platform Resolve a comment thread", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/comments-resolutions/:threadId", "params": [ { "name": "threadId", "value": "", "type": "path", "description": "The comment's thread ID." } ] }, "docs": "Resolves a comment and any associated replies. On success, this returns an HTTP `204 No Content` response.\n\nComment thread IDs return in the GET comments response for [APIs](https://www.postman.com/postman/workspace/postman-public-workspace/request/12959542-2103ea20-f7de-4628-90e6-b823b3084a52), [collections](https://www.postman.com/postman/workspace/postman-public-workspace/request/12959542-a6582e0a-9382-4760-8b91-53a8aa6cb8d7), and [collection items](https://www.postman.com/postman/workspace/p" } ] } ], "bundled": true }