class Amazonite::ApiGateway::ImportRestApiRequest

Overview

A POST request to import an API to API Gateway using an input of an API definition file.

Included Modules

Defined in:

api_gateway/import_rest_api_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(body : String, fail_on_warnings : Bool | Nil = nil, parameters : Hash(String, String) | Nil = nil) #

[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 POST 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 POST 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 creation (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 creation (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 parameters : Hash(String, String) | Nil #

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set #parameters as ignore=documentation.

To configure the endpoint type, set #parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set #parameters as basepath=ignore, basepath=prepend or basepath=split.


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

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set #parameters as ignore=documentation.

To configure the endpoint type, set #parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set #parameters as basepath=ignore, basepath=prepend or basepath=split.


[View source]
def validate! : Nil #

[View source]