Skip to content

Update Documentation Version

apigateway_update_documentation_version R Documentation

Updates a documentation version

Description

Updates a documentation version.

Usage

apigateway_update_documentation_version(restApiId, documentationVersion,
  patchOperations)

Arguments

restApiId

[required] The string identifier of the associated RestApi.

documentationVersion

[required] The version identifier of the to-be-updated documentation version.

patchOperations

For more information about supported patch operations, see Patch Operations.

Value

A list with the following syntax:

list(
  version = "string",
  createdDate = as.POSIXct(
    "2015-01-01"
  ),
  description = "string"
)

Request syntax

svc$update_documentation_version(
  restApiId = "string",
  documentationVersion = "string",
  patchOperations = list(
    list(
      op = "add"|"remove"|"replace"|"move"|"copy"|"test",
      path = "string",
      value = "string",
      from = "string"
    )
  )
)