class Aws::APIGateway::Types::ImportDocumentationPartsRequest

Import documentation parts from an external (e.g., OpenAPI) definition file.

@note When making an API call, you may pass ImportDocumentationPartsRequest

data as a hash:

    {
      rest_api_id: "String", # required
      mode: "merge", # accepts merge, overwrite
      fail_on_warnings: false,
      body: "data", # required
    }

@!attribute [rw] rest_api_id

\[Required\] The string identifier of the associated RestApi.
@return [String]

@!attribute [rw] 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`.
@return [String]

@!attribute [rw] fail_on_warnings

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`.
@return [Boolean]

@!attribute [rw] body

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

Constants

SENSITIVE