paws.networking (version 0.1.11)

apigateway_get_documentation_part: Get documentation part

Description

Get documentation part

Usage

apigateway_get_documentation_part(restApiId, documentationPartId)

Arguments

restApiId

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

documentationPartId

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

Value

A list with the following syntax:

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_part(
  restApiId = "string",
  documentationPartId = "string"
)