Amazon API Gateway REST API Reference

DocumentationParts

The collection of documentation parts of an API.


Relation Description Method Templated
self

A relation that refers to the current resource.

GET No
documentationpart:by-id

Gets a DocumentationPart of a specified documentation part identifier.

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

  • part_id: Required.

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

GET Yes
documentationpart:create

Creates a documentation part for an API entity with a given DocumentationPart as the input.

POST No
documentationpart:import

Imports the documentation parts as specified in an external definition file, e.g., a Swagger file.

PUT No
next

The next page of DocumentationPart resources in the DocumentationParts collection. Not valid for the last item in the collection.

GET No
first

The first page of DocumentationPart resources in the DocumentationParts collection.

GET No
item

The current page of DocumentationPart resources in the DocumentationParts collection.

GET No


Properties

The DocumentationParts resource does not have any properties.

Remarks

See Also

Documenting an API, DocumentationPart