x-yc-apigateway-integration:http extension
The x-yc-apigateway-integration:http
extension redirects a request to the specified URL. The request is sent in the form it was received in from the client.
Supported parameters
The table below lists the parameters specific to API Gateway API gateways. Read more about other parameters in the OpenAPI Specification 3.0.
Parameter | Type | Description |
---|---|---|
url |
string |
URL to redirect the invocation to (must be accessible from the internet). Parameters are substituted in url . |
method |
enum |
Optional parameter. HTTP method used for the invocation. If the parameter is omitted, it defaults to the method of request to API Gateway. |
headers |
map[string]string |
HTTP headers to be passed in addition to the original request headers. Parameters are substituted in headers . |
timeouts |
object |
Optional parameter. The read and connect invocation timeouts, in seconds. |
Extension specification
Sample specification:
x-yc-apigateway-integration:
type: http
url: https://example.com/backend1
method: POST
headers:
Authorization: Basic ZjTqBB3f$IF9gdYAGlMrs2fuINjHsz
timeouts:
connect: 0.5
read: 5
Extension specifics:
- By default, the original request headers are not passed, but this can be done through parameter substitution. In this case, you should provide the
default
parameter header.