x-apigateway-backend.functionEndpoints
Meaning: Function backend service definition.
Scope of effect: x-apigateway-backend
Example:
paths:'/users/{userId}':get:produces:- "application/json"parameters:- name: "X-Auth-Token"description: "Authentication token"type: "string"in: "header"required: trueresponses:default:description: "default response"x-apigateway-request-type: "public"x-apigateway-backend:type: "FUNCTION"functionEndpoints:version: "v1"function-urn: ""invocation-type: "synchronous"timeout: 30000
Parameter | Mandatory | Type | Description |
---|---|---|---|
function-urn | Yes | String | Function URN. |
version | Yes | String | Function version. |
invocation-type | Yes | String | Function invocation type. The value can be asynchronous or synchronous. |
timeout | No | Number | Function timeout in milliseconds. The value ranges from 1 to 60,000, and the default value is 5000. |
Parent topic: API Design File Extension Definitions