Get Export

apigateway_get_export

R Documentation

Exports a deployed version of a RestApi in a specified format

Description

Exports a deployed version of a RestApi in a specified format.

Usage

apigateway_get_export(restApiId, stageName, exportType, parameters,
  accepts)

Arguments

restApiId

[required] The string identifier of the associated RestApi.

stageName

[required] The name of the Stage that will be exported.

exportType

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

parameters

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

accepts

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.

Value

A list with the following syntax:

list(
  contentType = "string",
  contentDisposition = "string",
  body = raw
)

Request syntax

svc$get_export(
  restApiId = "string",
  stageName = "string",
  exportType = "string",
  parameters = list(
    "string"
  ),
  accepts = "string"
)