Class: Aws::APIGateway::Types::ImportDocumentationPartsRequest

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::ImportDocumentationPartsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

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
}

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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #body ⇒ String

  [Required] Raw byte array representing the to-be-imported documentation parts.

• #fail_on_warnings ⇒ Boolean

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

• #mode ⇒ String

  A query parameter to indicate whether to overwrite (‘OVERWRITE`) any existing DocumentationParts definition or to merge (`MERGE`) the new definition into the existing one.

• #rest_api_id ⇒ String

  [Required] The string identifier of the associated RestApi.

Instance Attribute Details

#body ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 4517

class ImportDocumentationPartsRequest < Struct.new(
  :rest_api_id,
  :mode,
  :fail_on_warnings,
  :body)
  SENSITIVE = []
  include Aws::Structure
end

#fail_on_warnings ⇒ Boolean

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`.

Returns:

• (Boolean)

# File 'lib/aws-sdk-apigateway/types.rb', line 4517

class ImportDocumentationPartsRequest < Struct.new(
  :rest_api_id,
  :mode,
  :fail_on_warnings,
  :body)
  SENSITIVE = []
  include Aws::Structure
end

#mode ⇒ String

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`.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 4517

class ImportDocumentationPartsRequest < Struct.new(
  :rest_api_id,
  :mode,
  :fail_on_warnings,
  :body)
  SENSITIVE = []
  include Aws::Structure
end

#rest_api_id ⇒ String

[Required] The string identifier of the associated RestApi.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 4517

class ImportDocumentationPartsRequest < Struct.new(
  :rest_api_id,
  :mode,
  :fail_on_warnings,
  :body)
  SENSITIVE = []
  include Aws::Structure
end