class Amazonite::ApiGateway::GetExportRequest

Overview

Request a new export of a RestApi for a particular Stage.

Included Modules

Defined in:

api_gateway/get_export_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(rest_api_id : String, stage_name : String, export_type : String, parameters : Hash(String, String) | Nil = nil, accepts : String | Nil = nil) #

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

[View source]
def self.new(*, __pull_for_json_serializable 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 accepts : String | Nil #

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.


[View source]
def accepts=(accepts : String | Nil) #

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.


[View source]
def export_type : String #

The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.


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

The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.


[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 query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool


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

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool


[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 stage_name : String #

The name of the Stage that will be exported.


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

The name of the Stage that will be exported.


[View source]
def validate! : Nil #

[View source]