{ "opencollection": "1.0.0", "info": { "name": "APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Collection Requests API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Collection Requests", "type": "folder" }, "items": [ { "info": { "name": "APIs.io Engineering Platform Create a request", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/requests", "params": [ { "name": "collectionId", "value": "", "type": "path", "description": "The collection's ID." }, { "name": "folderId", "value": "", "type": "query", "description": "The folder ID in which to create the request. By default, the system will create the request at the collection level." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a request in a collection. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).\n\n**Note:**\n\nIt is recommended that you pass the `name` property in the request body. If you do not, the system uses a null value. As a result, this creates a request with a blank name.\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 request", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/requests/:requestId", "params": [ { "name": "requestId", "value": "", "type": "path", "description": "The request's ID." }, { "name": "collectionId", "value": "", "type": "path", "description": "The collection's ID." }, { "name": "ids", "value": "", "type": "query", "description": "If true, returns only properties that contain ID values in the response." }, { "name": "uid", "value": "", "type": "query", "description": "If true, returns all IDs in UID format (`userId`-`id`)." }, { "name": "populate", "value": "", "type": "query", "description": "If true, returns all of the collection item's contents." } ] }, "docs": "Gets information about a request in a collection." }, { "info": { "name": "APIs.io Engineering Platform Update a request", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/requests/:requestId", "params": [ { "name": "requestId", "value": "", "type": "path", "description": "The request's ID." }, { "name": "collectionId", "value": "", "type": "path", "description": "The collection's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a request in a collection. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).\n\n**Note:**\n\n- You must pass a collection ID (`12ece9e1-2abf-4edc-8e34-de66e74114d2`), not a collection(`12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2`), in this endpoint.\n- This endpoint does not support changing the folder of a request.\n" }, { "info": { "name": "APIs.io Engineering Platform Delete a request", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/collections/:collectionId/requests/:requestId", "params": [ { "name": "requestId", "value": "", "type": "path", "description": "The request's ID." }, { "name": "collectionId", "value": "", "type": "path", "description": "The collection's ID." } ] }, "docs": "Deletes a request in a collection." } ] } ], "bundled": true }