class
Amazonite::ApiGateway::GetExportRequest
- Amazonite::ApiGateway::GetExportRequest
- Reference
- Object
Overview
Request a new export of a RestApi for a particular Stage.
Included Modules
- JSON::Serializable
Defined in:
api_gateway/get_export_request.crConstructors
- .new(rest_api_id : String, stage_name : String, export_type : String, parameters : Hash(String, String) | Nil = nil, accepts : String | Nil = nil)
- .new(pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#accepts : String | Nil
The content-type of the export, for example
application/json. -
#accepts=(accepts : String | Nil)
The content-type of the export, for example
application/json. -
#export_type : String
The type of export.
-
#export_type=(export_type : String)
The type of export.
-
#hash(hasher)
See
Object#hash(hasher) -
#parameters : Hash(String, String) | Nil
A key-value map of query string parameters that specify properties of the export, depending on the requested
exportType. -
#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. -
#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.
-
#stage_name : String
The name of the Stage that will be exported.
-
#stage_name=(stage_name : String)
The name of the Stage that will be exported.
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
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.
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.
The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
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
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