x-yc-apigateway-integration:cloud_functions extension
The x-yc-apigateway-integration:cloud-functions extension invokes the specified function. As its input, the function accepts the HTTP request data and values of the parameters listed in the specification. As the output, it returns the result of function execution to the client. The request data is transmitted in the same format as that of the current version of the HTTP integration when invoking the function with the integration=raw request string parameter that is most compatible with the AWS API Gateway format. The values of parameters listed in the specification are passed to the params field of the data parameter.
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 |
|---|---|---|
function_id |
string |
Function ID. |
tag |
string |
Optional parameter. Version tag. The default value is $latest. Parameters are substituted in tag. |
service_account_id |
string |
ID of the service account used for authorization when accessing the function. If the parameter is omitted, the value of the top-level service_account_id parameter is used. If there is no top-level parameter, the function is invoked without authorization. |
payload_format_version |
string |
Function call format version. Legal values: 0.1 and 1.0. Default version: 0.1. |
context |
object |
Optional parameter. Operation context is an arbitrary object in YAML or JSON format. Passed to a function inside a request using the requestContext.apiGateway.operationContext field. Parameter substitution takes place in context. |
Extension specification
Example specification:
/example/{ID}:
get:
summary: Get ID
operationId: getID
tags:
- example
parameters:
- name: ID
in: path
description: Return ID
required: true
schema:
type: string
x-yc-apigateway-integration:
type: cloud_functions
function_id: b095c95icnvbuf4v755l
tag: "$latest"
service_account_id: ajehfe56hhlsd4n93q1
Function example:
exports.handler= async function (data, context) {
return {
'statusCode': 200,
'isBase64Encoded': false,
'body': JSON.stringify({
'petId': data.params.ID
}),
}
};
Request structure for v0. 1
The request JSON structure for version 0.1 replicates the request structure to a function with some additional fields:
{
"url": <actual request path>,
"path": <path corresponding to specification request>,
"httpMethod": <HTTP method name>,
"headers": <dictionary with HTTP header string values>,
"multiValueHeaders": <dictionary with lists of HTTP header values>,
"queryStringParameters": <dictionary of queryString parameters>,
"multiValueQueryStringParameters": <dictionary with lists of queryString parameter values>,
"requestContext": <dictionary with request context>,
"body": <request body>,
"isBase64Encoded": <true or false>,
"pathParams": <dictionary of request path parameter values>,
"params": <dictionary of request parameter values as described in OpenAPI spec>,
"multiValueParams": <dictionary with lists of request parameter values as described in the OpenAPI spec>
}
Request structure for v1.0
Request JSON structure for version 1.0 is compatible with the request format for AWS API Gateway version 1.0 with some additional fields:
{
"version": <request format version>,
"resource": <resource corresponding to specification request>,
"path": <actual request path>,
"httpMethod": <HTTP method name>,
"headers": <dictionary with HTTP header string values>,
"multiValueHeaders": <dictionary with lists of HTTP header values>,
"queryStringParameters": <dictionary of queryString parameters>,
"multiValueQueryStringParameters": <dictionary with lists of queryString parameter values>,
"requestContext": <dictionary with request context>,
"pathParameters": <dictionary of request path parameter values>,
"body": <request body>,
"isBase64Encoded": <true or false>,
// additional fields:
"parameters": <dictionary of request parameter values as described in the OpenAPI spec>,
"multiValueParameters": <dictionary with request parameter value lists as described in the OpenAPI spec>
"operationId": <operationId corresponding to the request in the OpenAPI spec>
}