Import Documentation Parts

apigateway_import_documentation_parts

R Documentation

Imports documentation parts¶

Description¶

Imports documentation parts

Usage¶

apigateway_import_documentation_parts(restApiId, mode, failOnWarnings,
  body)

Arguments¶

restApiId

[required] The string identifier of the associated RestApi.

mode

A query parameter to indicate whether to overwrite (overwrite) any existing DocumentationParts definition or to merge (merge) the new definition into the existing one. The default value is merge.

failOnWarnings

A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.

body

[required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.

Value¶

A list with the following syntax:

list(
  ids = list(
    "string"
  ),
  warnings = list(
    "string"
  )
)

Request syntax¶

svc$import_documentation_parts(
  restApiId = "string",
  mode = "merge"|"overwrite",
  failOnWarnings = TRUE|FALSE,
  body = raw
)