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
- Struct
- Aws::APIGateway::Types::ImportDocumentationPartsRequest
- Defined in:
- (unknown)
Overview
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., OpenAPI) definition file.
Instance Attribute Summary collapse
-
#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.
#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
.
#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
.
Possible values:
- merge
- overwrite
#rest_api_id ⇒ String
[Required] The string identifier of the associated RestApi.