Skip to content

Get Documentation Versions

apigateway_get_documentation_versions R Documentation

Gets documentation versions

Description

Gets documentation versions.

Usage

apigateway_get_documentation_versions(restApiId, position, limit)

Arguments

restApiId

[required] The string identifier of the associated RestApi.

position

The current pagination position in the paged result set.

limit

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Value

A list with the following syntax:

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

Request syntax

svc$get_documentation_versions(
  restApiId = "string",
  position = "string",
  limit = 123
)