apigateway_create_documentation_part: Create documentation part

Description Usage Arguments Value Request syntax

View source: R/apigateway_operations.R

Description

Create documentation part

Usage

1
apigateway_create_documentation_part(restApiId, location, properties)

Arguments

restApiId

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

location

[required] [Required] The location of the targeted API entity of the to-be-created documentation part.

properties

[required] [Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
svc$create_documentation_part(
  restApiId = "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"
)

paws.networking documentation built on Aug. 23, 2021, 9:07 a.m.