x-yc-apigateway-integration:cloud_datastreams extension
Written by
The x-yc-apigateway-integration:cloud_datastreams extension enables you to access Yandex Data Streams for performing operations with streams. Currently, the only supported operation is PutRecord.
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 |
|---|---|---|
action |
string |
Operation in progress. Valid values: PutRecord. |
stream_name |
string |
Data Streams stream name. |
partition_key |
string |
This is an optional parameter. Shard key. If not specified, writing will be performed to a random segment. Partition_key is where parameter substitution takes place. |
payload_format_type |
string |
This is an optional parameter. Type of record content. If the value is body, only the request body will be written to the stream. If the value is request, the entire request in JSON format will be written to the stream. The default value is body. |
service_account_id |
string |
Service account ID. Used for authorization when performing Data Streams stream operations. If this parameter is not specified, the value of the top-level service_account_id parameter is used. |
Extension specification
Example specification:
/pets-stream/{petId}:
post:
x-yc-apigateway-integration:
type: cloud_datastreams
action: PutRecord
stream_name: /ru-central1/b1v1emj927uvf97q62lt/ett01h3uz7qm8rjv0rsh/pets-stream
partition_key: '{petId}'
service_account_id: ajeqvh23fi2mfdoq6ba
parameters:
- description: petId
explode: false
in: path
name: petId
required: true
schema:
type: string
style: simple