{ "opencollection": "1.0.0", "info": { "name": "APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Schema API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Schema", "type": "folder" }, "items": [ { "info": { "name": "APIs.io Engineering Platform Create a schema", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/apis/:apiId/schemas", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The API's ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a schema for an API." }, { "info": { "name": "APIs.io Engineering Platform Get a schema", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/apis/:apiId/schemas/:schemaId", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The API's ID." }, { "name": "schemaId", "value": "", "type": "path", "description": "The API schema's ID." }, { "name": "versionId", "value": "", "type": "query", "description": "The API's version ID." }, { "name": "bundled", "value": "", "type": "query", "description": "If true, return the schema in a bundled format." } ] }, "docs": "Gets information about API schema. You can use the `versionId` query parameter to get a schema published in an API version.\n\nYou can use this API to do the following:\n\n- Get a schema's metadata.\n- Get all the files in a schema. This only returns the first file in the schema. The endpoint response contains a link to the next set of response results.\n- Get a schema's contents in multi-file or bundled format.\n\n**Note:**\n\nThe `versionId` query parameter is a required parameter for API viewers.\n" }, { "info": { "name": "APIs.io Engineering Platform Get schema files", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/apis/:apiId/schemas/:schemaId/files", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The API's ID." }, { "name": "schemaId", "value": "", "type": "path", "description": "The API schema's ID." }, { "name": "versionId", "value": "", "type": "query", "description": "The API's version ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of rows to return in the response." }, { "name": "cursor", "value": "", "type": "query", "description": "The pointer to the first record of the set of paginated results. To view the next response, use the `nextCursor` value for this parameter." } ] }, "docs": "Gets the files in an API schema. You can use the `versionId` query parameter to get schema files published in an API version.\n\n**Note:**\n\nThe `versionId` query parameter is a required parameter for API viewers.\n" }, { "info": { "name": "APIs.io Engineering Platform Get schema file contents", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/apis/:apiId/schemas/:schemaId/files/:file-path", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The API's ID." }, { "name": "schemaId", "value": "", "type": "path", "description": "The API schema's ID." }, { "name": "file-path", "value": "", "type": "path", "description": "The path to the schema file." }, { "name": "versionId", "value": "", "type": "query", "description": "The API's version ID." } ] }, "docs": "Gets an API schema file contents at the defined path. You can use the `versionId` query parameter to get schema file contents published in an API version.\n\n**Note:**\n\nThe `versionId` query parameter is a required parameter for API viewers.\n" }, { "info": { "name": "APIs.io Engineering Platform Create or update a schema file", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/apis/:apiId/schemas/:schemaId/files/:file-path", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The API's ID." }, { "name": "schemaId", "value": "", "type": "path", "description": "The API schema's ID." }, { "name": "file-path", "value": "", "type": "path", "description": "The path to the schema file." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates an API schema file.\n\n**Note:**\n\n- If the provided file path exists, the file is updated with the new contents.\n- If the provided file path does not exist, then a new schema file is created.\n- If the file path contains a `/` (forward slash) character, then a folder is created. For example, if the file path is the `dir/schema.json` value, then a `dir` folder is created with the `schema.json` file inside.\n- You can only update the `root` tag for protobuf specifications.\n" }, { "info": { "name": "APIs.io Engineering Platform Delete a schema file", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/apis/:apiId/schemas/:schemaId/files/:file-path", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The API's ID." }, { "name": "schemaId", "value": "", "type": "path", "description": "The API schema's ID." }, { "name": "file-path", "value": "", "type": "path", "description": "The path to the schema file." } ] }, "docs": "Deletes a file in an API schema. On success, this returns an HTTP `204 No Content` response." } ] } ], "bundled": true }