class
Amazonite::ApiGateway::PutRestApiRequest
- Amazonite::ApiGateway::PutRestApiRequest
- Reference
- Object
Overview
A PUT request to update an existing API, with external API definitions specified as the request body.
Included Modules
- JSON::Serializable
Defined in:
api_gateway/put_rest_api_request.crConstructors
- .new(rest_api_id : String, body : String, mode : PutMode | Nil = nil, fail_on_warnings : Bool | Nil = nil, parameters : Hash(String, String) | Nil = nil)
- .new(pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#body : String
The PUT request body containing external API definitions.
-
#body=(body : String)
The PUT request body containing external API definitions.
-
#fail_on_warnings : Bool | Nil
A query parameter to indicate whether to rollback the API update (
true) or not (false) when a warning is encountered. -
#fail_on_warnings=(fail_on_warnings : Bool | Nil)
A query parameter to indicate whether to rollback the API update (
true) or not (false) when a warning is encountered. -
#hash(hasher)
See
Object#hash(hasher) -
#mode : PutMode | Nil
The
#modequery parameter to specify the update mode. -
#mode=(mode : PutMode | Nil)
The
#modequery parameter to specify the update mode. -
#parameters : Hash(String, String) | Nil
Custom header parameters as part of the request.
-
#parameters=(parameters : Hash(String, String) | Nil)
Custom header parameters as part of the request.
-
#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?.
The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.
The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.
A query parameter to indicate whether to rollback the API update (true) or not (false) when
a warning is encountered. The default value is false.
A query parameter to indicate whether to rollback the API update (true) or not (false) when
a warning is encountered. The default value is false.
The #mode query parameter to specify the update mode. Valid values are "merge" and "overwrite".
By default, the update mode is "merge".
The #mode query parameter to specify the update mode. Valid values are "merge" and "overwrite".
By default, the update mode is "merge".
Custom header parameters as part of the request. For example, to exclude DocumentationParts from
an imported API, set ignore=documentation as a #parameters value, as in the AWS CLI command
of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.
Custom header parameters as part of the request. For example, to exclude DocumentationParts from
an imported API, set ignore=documentation as a #parameters value, as in the AWS CLI command
of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.