x-yc-apigateway-integration:cloud_datastreams extension
Written by
Updated at December 5, 2024
The x-yc-apigateway-integration:cloud_datastreams extension enables you to access Yandex Data Streams to run operations on streams. Currently, the only supported operation is PutRecord.
You can add an extension to a specification using the specification constructor.
Supported parameters
The table below lists the parameters specific to API Gateway API gateways. You can find the description of other parameters in the OpenAPI 3.0 specification.
| Parameter | Type | Description |
|---|---|---|
action |
string |
Operation in progress. Possible values: PutRecord. |
stream_name |
string |
Data Streams stream name. |
partition_key |
string |
This is an optional parameter. Shard key. If it is not specified, the writing operation will be performed to a random segment. The parameters are subsituted into partition_key. |
payload_format_type |
string |
This is an optional parameter. It determines what is to be written. If the value is body, only the request body will be written to the stream. If the value is request, the whole request in JSON format will be written to the stream. The default value is body. |
service_account_id |
string |
Service account ID. It is used for authorization when performing Data Streams stream operations. If you omit the parameter, the service_account_id top-level parameter value will be used. |
Extension specification
Specification example:
/pets-stream/{petId}:
post:
x-yc-apigateway-integration:
type: cloud_datastreams
action: PutRecord
stream_name: /ru-central1/b1v1emj927uv********/ett01h3uz7qm********/pets-stream
partition_key: '{petId}'
service_account_id: ajeqvh23fi2********
parameters:
- description: petId
explode: false
in: path
name: petId
required: true
schema:
type: string
style: simple