class
Amazonite::ApiGateway::ImportRestApiRequest
- Amazonite::ApiGateway::ImportRestApiRequest
- Reference
- Object
Overview
A POST request to import an API to API Gateway using an input of an API definition file.
Included Modules
- JSON::Serializable
Defined in:
api_gateway/import_rest_api_request.crConstructors
- .new(pull : JSON::PullParser)
- .new(body : String, fail_on_warnings : Bool | Nil = nil, parameters : Hash(String, String) | Nil = nil)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#body : String
The POST request body containing external API definitions.
-
#body=(body : String)
The POST request body containing external API definitions.
-
#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. -
#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. -
#hash(hasher)
See
Object#hash(hasher) -
#parameters : Hash(String, String) | Nil
A key-value map of context-specific query string parameters specifying the behavior of different API importing operations.
-
#parameters=(parameters : Hash(String, String) | Nil)
A key-value map of context-specific query string parameters specifying the behavior of different API importing operations.
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
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.
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.
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.
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.
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.
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.