Create documentation part
Create documentation part
apigateway_create_documentation_part(restApiId, location, properties)
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. |
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"
)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"
)Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.