Gets documentation parts¶

Description¶

Gets documentation parts.

Usage¶

apigateway_get_documentation_parts(restApiId, type, nameQuery, path,
  position, limit, locationStatus)

Arguments¶

restApiId

[required] The string identifier of the associated RestApi.
type

The type of API entities of the to-be-retrieved documentation parts.
nameQuery

The name of API entities of the to-be-retrieved documentation parts.
path

The path of API entities of the to-be-retrieved documentation parts.
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.
locationStatus

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

Value¶

A list with the following syntax:

list(
  position = "string",
  items = list(
    list(
      id = "string",
      location = list(
        type = "API"|"AUTHORIZER"|"MODEL"|"RESOURCE"|"METHOD"|"PATH_PARAMETER"|"QUERY_PARAMETER"|"REQUEST_HEADER"|"REQUEST_BODY"|"RESPONSE"|"RESPONSE_HEADER"|"RESPONSE_BODY",
        path = "string",
        method = "string",
        statusCode = "string",
        name = "string"
      ),
      properties = "string"
    )
  )
)

Request syntax¶

svc$get_documentation_parts(
  restApiId = "string",
  type = "API"|"AUTHORIZER"|"MODEL"|"RESOURCE"|"METHOD"|"PATH_PARAMETER"|"QUERY_PARAMETER"|"REQUEST_HEADER"|"REQUEST_BODY"|"RESPONSE"|"RESPONSE_HEADER"|"RESPONSE_BODY",
  nameQuery = "string",
  path = "string",
  position = "string",
  limit = 123,
  locationStatus = "DOCUMENTED"|"UNDOCUMENTED"
)