paws.networking: apigateway_import_documentation_parts – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

apigateway_import_documentation_parts

Import documentation parts

Import documentation parts

apigateway_import_documentation_parts(restApiId, mode, failOnWarnings,
  body)

`restApiId`	[required] [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] [Required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.

A list with the following syntax:

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

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

Amazon Web Services Networking & Content Delivery Services

v0.1.11

Apache License (>= 2.0)

Authors

David Kretch [aut, cre], Adam Banker [aut], Amazon.com, Inc. [cph]

Initial release