Skip to contents

Imports documentation parts

Source: R/apigateway_operations.R
apigateway_import_documentation_parts.Rd

Imports documentation parts

See https://www.paws-r-sdk.com/docs/apigateway_import_documentation_parts/ for full documentation.

Usage

apigateway_import_documentation_parts(
  restApiId,
  mode = NULL,
  failOnWarnings = NULL,
  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.