Amazon API Gateway REST API Reference

DocumentationPartIds

A collection of the imported DocumentationPart identifiers.


Relation Description Method Templated
self

A relation that refers to the current resource.

GET No
documentationpart:by-id

Gets the DocumentationPart of the specified identifier.

GET No
documentationpart:create

Creates a documentation part and adds it to the DocumentationParts collection.

POST No


Properties

{
  "ids" : [ "String" ],
  "warnings" : [ "String" ]
}

  • ids
  • A list of the returned documentation part identifiers.

  • warnings
  • A list of warning messages reported during import of documentation parts.

Remarks

This is used to return the result when documentation parts in an external (e.g., Swagger) file are imported into Amazon API Gateway

See Also

Documenting an API, documentationpart:import, DocumentationPart