Amazon API Gateway Documentation API
Operations for managing API documentation
Amazon API Gateway Documentation API is one of 18 APIs that Amazon API Gateway publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 8 JSON Schema definitions.
Tagged areas include Documentation. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, pricing, a getting-started guide, an API reference, a JSON-LD context, and 8 JSON Schemas.
This API exposes 4 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 2015-07-09.
Requests are made against a single base URL, https://apigateway.{region}.amazonaws.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Amazon API Gateway Documentation API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (sigv4).
By default, every request must be authenticated.
sigv4— AWS Signature Version 4 authentication
Paths & Operations 4
Across 2 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Operations for managing API documentation
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are DocumentationVersion (3 properties), DocumentationPart (3 properties), CreateDocumentationVersionRequest (3 properties), Error (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Amazon API Gateway 12
Other APIs Amazon API Gateway publishes across the network.