Amazon API Gateway REST API Reference

DocumentationVersions

The collection of documentation snapshots of an API.


Relation Description Method Templated
self

A relation that refers to the current resource.

GET No
documentationversion:by-version

Gets a documentation snapshot of an API.

This link relation offers the following templated variable(s):

  • doc_version: Required.

    [Required] The version identifier of the to-be-retrieved documentation snapshot.

GET Yes
documentationversion:create

Creates a documentation snapshot of an API.

POST No
next

The next page of DocumentationVersion items from the DocumentationVersions collection of an API. Not valid for the last item in a collection.

GET No
first

The first page of DocumentationVersion items from the DocumentationVersions collection of an API.

GET No
item

The current page of DocumentationVersion items from the DocumentationVersions collection of an API.

GET No


Properties

The DocumentationVersions resource does not have any properties.

Remarks

Use the DocumentationVersions to manage documentation snapshots associated with various API stages.

See Also

Documenting an API, DocumentationPart, DocumentationVersion