class
Amazonite::ApiGateway::ImportDocumentationPartsRequest
- Amazonite::ApiGateway::ImportDocumentationPartsRequest
- Reference
- Object
Overview
Import documentation parts from an external (e.g., OpenAPI) definition file.
Included Modules
- JSON::Serializable
Defined in:
api_gateway/import_documentation_parts_request.crConstructors
- .new(rest_api_id : String, body : String, mode : PutMode | Nil = nil, fail_on_warnings : Bool | Nil = nil)
- .new(pull : JSON::PullParser)
- .new(*, __pull_for_json_serializable pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#body : String
Raw byte array representing the to-be-imported documentation parts.
-
#body=(body : String)
Raw byte array representing the to-be-imported documentation parts.
-
#fail_on_warnings : Bool | Nil
A query parameter to specify whether to rollback the documentation importation (
true) or not (false) when a warning is encountered. -
#fail_on_warnings=(fail_on_warnings : Bool | Nil)
A query parameter to specify whether to rollback the documentation importation (
true) or not (false) when a warning is encountered. -
#hash(hasher)
See
Object#hash(hasher) -
#mode : PutMode | Nil
A query parameter to indicate whether to overwrite (
overwrite) any existing DocumentationParts definition or to merge (merge) the new definition into the existing one. -
#mode=(mode : PutMode | Nil)
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
The string identifier of the associated RestApi.
-
#rest_api_id=(rest_api_id : String)
The string identifier of the associated RestApi.
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.
Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.
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.
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.
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.
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.