Amazon API Gateway REST API Reference

DocumentationVersion

A snapshot of the documentation of an API.


Relation Description Method Templated
self

A relation that refers to the current resource.

GET No
documentationversion:update

Updates the documentation version of an API.

PATCH No
documentationversion:delete

Deletes the documentation version of an API.

DELETE No


Properties

{
  "version" : "String",
  "createdDate" : "Timestamp",
  "description" : "String"
}

  • version
  • The version identifier of the API documentation snapshot.

  • createdDate
  • The date when the API documentation snapshot is created.

  • description
  • The description of the API documentation snapshot.

Remarks

Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., Swagger) file.

See Also

Documenting an API, DocumentationPart, DocumentationVersions