class Amazonite::ApiGateway::PutRestApiRequest

Overview

A PUT request to update an existing API, with external API definitions specified as the request body.

Included Modules

Defined in:

api_gateway/put_rest_api_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(rest_api_id : String, body : String, mode : PutMode | Nil = nil, fail_on_warnings : Bool | Nil = nil, parameters : Hash(String, String) | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def body : String #

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.


[View source]
def body=(body : String) #

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.


[View source]
def 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. The default value is false.


[View source]
def 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. The default value is false.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def mode : PutMode | Nil #

The #mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".


[View source]
def mode=(mode : PutMode | Nil) #

The #mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".


[View source]
def parameters : Hash(String, String) | Nil #

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


[View source]
def parameters=(parameters : Hash(String, String) | Nil) #

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


[View source]
def rest_api_id : String #

The string identifier of the associated RestApi.


[View source]
def rest_api_id=(rest_api_id : String) #

The string identifier of the associated RestApi.


[View source]
def validate! : Nil #

[View source]