Overview
x-yc-apigateway extension
The x-yc-apigateway extension lets you set top-level API gateway parameters whose values will be inherited by nested extensions.
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 |
|---|---|---|
service_account_id |
string |
ID of the service account on behalf of which the API gateway will perform operations. |
Extension specification
x-yc-apigateway:
service_account_id: <service account ID>
x-yc-apigateway-integration extension
The x-yc-apigateway-integration extension is the entry point for integrating the API gateway with other services.
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 |
|---|---|---|
type |
string |
Extension type. Possible values: dummy, cloud_functions, http, and object_storage. |
Extension specification
<Request>:
<Method>:
x-yc-apigateway-integration:
type: <Type>
<List of parameters as key:value pairs>
The extension's content changes depending on the type (type) specified in the x-yc-apigateway-integration section:
- dummy: returns fixed content with the specified response code and required headers without any third-party service involved.
- cloud_functions: invokes the specified function, passes the HTTP request data to it as input, and returns the result of this function to the client.
- http: redirects the request to the specified URL.
- object_storage: passes the request handling control to Object Storage for distributing static files.
All types support parameter substitution when all keys are replaced with the appropriate value. A key should be defined as a parameter of the corresponding operation (all types of parameters defined in the OpenAPI-Specification are allowed: path, query, header, and cookie).
Parameters are only substituted in some values, depending on the type of extension.