You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::APIGateway::Types::GetExportRequestWhen passing GetExportRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
rest_api_id: "String", stage_name: "String", export_type: "String", parameters: {
"String" => "String",
},
accepts: "String",
}
Request a new export of a RestApi for a particular Stage.
Instance Attribute Summary collapseThe content-type of the export, for example application/json
.
[Required] The type of export.
A key-value map of query string parameters that specify properties of the export, depending on the requested exportType
.
[Required] The string identifier of the associated RestApi.
[Required] The name of the Stage that will be exported.
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.
[Required] The type of export. Acceptable values are \'oas30\' for OpenAPI 3.0.x and \'swagger\' for Swagger/OpenAPI 2.0.
#parameters ⇒ Hash<String,String>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
[Required] The string identifier of the associated RestApi.
#stage_name ⇒ String[Required] The name of the Stage that will be exported.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4