Amazon API Gateway REST API Reference

documentationversion:create

Creates a documentation snapshot of an API.

HTTP Request

POST /restapis/<restapi_id>/documentation/versions

Request Body

{
  "documentationVersion" : "String",
  "stageName" : "String",
  "description" : "String"
}

Request Body Fields

The request accepts the following fields in JSON format.

  • documentationVersion
  • [Required] The version identifier of the new snapshot.

  • stageName
  • The stage name to be associated with the new documentation snapshot.

  • description
  • A description about the new documentation snapshot.

Response

DocumentationVersion

Remarks

The result is a DocumentationVersion instance.

See Also

Documenting an API, DocumentationPart, DocumentationVersion, DocumentationVersions