You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/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., Swagger) definition file.

Instance Attribute Summary collapse

Instance Attribute Details

#bodyString

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

Returns:

  • (String)


3755
3756
3757
3758
3759
3760
3761
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3755

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

#fail_on_warningsBoolean

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)


3755
3756
3757
3758
3759
3760
3761
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3755

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

#modeString

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)


3755
3756
3757
3758
3759
3760
3761
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3755

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

#rest_api_idString

[Required] The string identifier of the associated RestApi.

Returns:

  • (String)


3755
3756
3757
3758
3759
3760
3761
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3755

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