Examples of using Documentation part in English and their translations into Spanish
{-}
-
Colloquial
-
Official
To exclude the documentation parts from the API import,
To create a snapshot of an API's documentation parts and associate it with an API stage at the same time, submit the following POST request.
In this section, we describe how to create and maintain documentation parts of an API using the API Gateway REST API.
To create a snapshot of an API's documentation parts, create a new DocumentationVersion resource
By default, documentation parts are included,
To list the documentation parts of any type of API entities,
this shows the documentation parts for the page and type query parameters.
see the payload of the example request in Importing Documentation Parts Using the API Gateway REST API.
maintaining versions of the documentation parts as your API evolves.
supplying the documentation parts in the x-amazon-apigateway-documentation object as part of the input Swagger file of the API definition.
API Gateway API documentation consists of individual documentation parts associated with specific API entities that include API,
To update the documentation parts of any type of API entities,
authorizers query parameter to include the API documentation parts, API integrations
we get the following output, with the documentation parts listed within the x-amazon-apigateway-documentation object as an extension to a standard Swagger file.
by-id to retrieve documentation parts from API Gateway,
After a version of the documentation parts is associated with a stage, you can export the documentation parts together with the API entity definitions, to an external file, using the API Gateway console,
The documentation part's properties map of a QUERY_PARAMETER entity can be inherited by one of its child QUERY_PARAMETER entities.
In the MERGE mode, a new documentation part defined in the Swagger file is added to the DocumentationParts collection of the API.
For a Swagger-compliant attribute defined in the properties map of a documentation part, API Gateway inserts the attribute into the associated API entity definition.
The version identifier of the snapshot of the exported documentation parts.