OpenAPI Extensions Documentation

Scroll down for schema examples. Select a format for examples from the tabs above or the mobile navigation menu.

This documentation was automatically generated from a v0.1.0 SEMOASA file.

com.amazon.aws

x-amazon-apigateway-integration

x-amazon-apigateway-integration example

{
  "cacheKeyParameters": [
    "string"
  ],
  "cacheNamespace": "string",
  "credentials": "string",
  "contentHandling": "string",
  "httpMethod": "string"
}

cacheKeyParameters:
  - string
cacheNamespace: string
credentials: string
contentHandling: string
httpMethod: string

Specifies the integration of the method with the backend.

Specifies details of the backend integration used for this method. This extension is an extended property of the Swagger Operation object. The result is an API Gateway integration object.

AWS documentation page in the Amazon API Gateway Developer Guide

Property	Type	Required	Description
cacheNamespace	string	false	An API-specific tag group of related cached parameters.
credentials	string	false	For AWS IAM role-based credentials, specify the ARN of an appropriate IAM role. If unspecified, credentials will default to resource-based permissions that must be added manually to allow the API to access the resource. For more information, see Granting Permissions Using a Resource Policy.
contentHandling	string	false	Request payload encoding conversion types. Valid values are 1) CONVERT_TO_TEXT, for converting a binary payload into a Base64-encoded string or converting a text payload into a utf-8-encoded string or passing through the text payload natively without modification, and 2) CONVERT_TO_BINARY, for converting a text payload into Base64-decoded blob or passing through a binary payload natively without modification.
httpMethod	string	false	The HTTP method used in the integration request. For Lambda function invocations, the value must be POST.
cacheKeyParameters	[string]	false	A list of request parameters whose values are to be cached.

In the OpenAPI specification v2.0, this extension can be used as follows:

Object	Description
OperationObject	Describes a single API operation on a path.

In the OpenAPI specification v3.x, this extension can be used as follows:

Object	Description
OperationObject	Describes a single API operation on a path.