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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ImportDocumentationPartsRequest as input to an Aws::Client method, you can use a vanilla 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)

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

#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)

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

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

Possible values:

  • merge
  • overwrite

Returns:

  • (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_idString

[Required] The string identifier of the associated RestApi.

Returns:

  • (String)

    [Required] The string identifier of the associated RestApi.