From feb813e9ed8f4b6807cbe3124b715f6ed608f836 Mon Sep 17 00:00:00 2001 From: RajatPawar <18614743+RajatPawar@users.noreply.github.com> Date: Wed, 19 Aug 2026 14:32:16 -0700 Subject: [PATCH 1/2] feat(destinations): openapi for Outpost queue types (SQS/PubSub/RabbitMQ reshape + Azure Service Bus, Kafka) + drop SNS (ENG-4130) Co-Authored-By: Claude Opus 4.8 --- api/api.yaml | 254 ++++++++++++++----- api/generated/api.bundled.json | 263 +++++++++++++++----- api/generated/api.json | 439 ++++++++++++++++++++++++++------- 3 files changed, 745 insertions(+), 211 deletions(-) diff --git a/api/api.yaml b/api/api.yaml index 9ab7ed3..a33927e 100644 --- a/api/api.yaml +++ b/api/api.yaml @@ -3018,33 +3018,37 @@ paths: description: The type of the destination. For `slack`, set `metadata.url` to a Slack incoming webhook URL. The warehouse and message-queue types (`clickhouse`, - `snowflake`, `bigquery`, `redshift`, `sqs`, `sns`, - `eventbridge`, `pubsub`, `rabbitmq`) are configured via the `metadata` + `snowflake`, `bigquery`, `redshift`, `sqs`, `eventbridge`, + `pubsub`, `rabbitmq`, `azureservicebus`, `kafka`) are configured via the `metadata` and `secrets` fields documented below. example: webhook - enum: [webhook, kinesis, s3, slack, clickhouse, snowflake, bigquery, redshift, sqs, sns, eventbridge, pubsub, rabbitmq] + enum: [webhook, kinesis, s3, slack, clickhouse, snowflake, bigquery, redshift, sqs, eventbridge, pubsub, rabbitmq, azureservicebus, kafka] secrets: type: object description: Secrets for the destination. properties: awsKeyId: type: string - description: The AWS access key ID for the Kinesis or S3 destination. + description: The AWS access key ID for the `kinesis`, `s3`, and `sqs` + destinations. Required for `sqs`. example: AKIAIOSFODNN7EXAMPLE x-go-type-skip-optional-pointer: true awsSecretKey: type: string - description: The AWS secret access key for the Kinesis or S3 destination. + description: The AWS secret access key for the `kinesis`, `s3`, and `sqs` + destinations. Required for `sqs`. example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY x-go-type-skip-optional-pointer: true awsSessionToken: type: string - description: The AWS session token for the Kinesis or S3 destination. + description: The optional AWS session token for the `kinesis`, `s3`, and + `sqs` destinations. example: AQoEXAMPLEH4aoAH0gNCAPy... x-go-type-skip-optional-pointer: true password: type: string - description: The password for the `clickhouse` destination. + description: The password for the `clickhouse`, `rabbitmq`, and `kafka` + destinations. Required for `rabbitmq` and `kafka`. example: my-clickhouse-password x-go-type-skip-optional-pointer: true privateKey: @@ -3055,19 +3059,19 @@ paths: credentials: type: string description: The service-account credentials JSON for the `bigquery`, - `gcs`, and `pubsub` destinations. + `gcs`, and `pubsub` destinations. Required for `pubsub`. example: '{"type":"service_account", ...}' x-go-type-skip-optional-pointer: true accessKeyId: type: string - description: The AWS access key ID for the `redshift`, `sqs`, `sns`, - and `eventbridge` destinations. + description: The AWS access key ID for the `redshift` and `eventbridge` + destinations. example: AKIAIOSFODNN7EXAMPLE x-go-type-skip-optional-pointer: true secretAccessKey: type: string - description: The AWS secret access key for the `redshift`, `sqs`, `sns`, - and `eventbridge` destinations. + description: The AWS secret access key for the `redshift` and `eventbridge` + destinations. example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY x-go-type-skip-optional-pointer: true accessKey: @@ -3075,10 +3079,17 @@ paths: description: The account access key for the `azureblob` destination. example: my-azure-access-key x-go-type-skip-optional-pointer: true - uri: + username: + type: string + description: The username for the `rabbitmq` and `kafka` destinations. + Required for both. + example: ampersand + x-go-type-skip-optional-pointer: true + connectionString: type: string - description: The connection URI (embeds credentials) for the `rabbitmq` destination. - example: amqp://user:pass@rabbit.example.com:5672 + description: The connection string for the `azureservicebus` destination. + Required for `azureservicebus`. + example: Endpoint=sb://my-namespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=... x-go-type-skip-optional-pointer: true metadata: type: object @@ -3102,12 +3113,14 @@ paths: x-go-type-skip-optional-pointer: true endpointUrl: type: string - description: The endpoint URL for the Kinesis stream. + description: The endpoint URL for the `kinesis` stream, or the optional + custom endpoint URL for the `sqs` destination. example: https://kinesis.us-east-1.amazonaws.com x-go-type-skip-optional-pointer: true partitionKeyTemplate: type: string - description: The template for the partition key to use when sending events to Kinesis (a JMESPath template) + description: The template for the partition key (a JMESPath template). + Used by `kinesis`, and optionally by `kafka`. example: "data.user_id" x-go-type-skip-optional-pointer: true bucket: @@ -3163,6 +3176,7 @@ paths: projectId: type: string description: The Google Cloud project ID (`bigquery`, `pubsub`). + Required for `pubsub`. example: my-gcp-project x-go-type-skip-optional-pointer: true datasetId: @@ -3203,13 +3217,9 @@ paths: queueUrl: type: string description: The SQS queue URL for the `sqs` destination. + Required for `sqs`. example: https://sqs.us-east-1.amazonaws.com/123456789012/my-queue x-go-type-skip-optional-pointer: true - topicArn: - type: string - description: The SNS topic ARN for the `sns` destination. - example: arn:aws:sns:us-east-1:123456789012:my-topic - x-go-type-skip-optional-pointer: true eventBusName: type: string description: The EventBridge event bus name for the `eventbridge` destination. @@ -3223,13 +3233,52 @@ paths: topicId: type: string description: The Pub/Sub topic ID for the `pubsub` destination. + Required for `pubsub`. example: ampersand-events x-go-type-skip-optional-pointer: true - routingKey: + serverUrl: type: string - description: The routing key for the `rabbitmq` destination. + description: The AMQP server URL for the `rabbitmq` destination. + Required for `rabbitmq`. + example: amqp://rabbit.example.com:5672 + x-go-type-skip-optional-pointer: true + exchange: + type: string + description: The exchange to publish to for the `rabbitmq` destination. + Required for `rabbitmq`. example: ampersand.events x-go-type-skip-optional-pointer: true + tls: + type: boolean + description: Whether to connect over TLS. Optional for the `rabbitmq` + and `kafka` destinations. + example: true + x-go-type-skip-optional-pointer: true + name: + type: string + description: The queue or topic name for the `azureservicebus` destination. + Required for `azureservicebus`. + example: ampersand-events + x-go-type-skip-optional-pointer: true + brokers: + type: string + description: The comma-separated list of Kafka broker addresses for the + `kafka` destination. Required for `kafka`. + example: broker1.example.com:9092,broker2.example.com:9092 + x-go-type-skip-optional-pointer: true + topic: + type: string + description: The Kafka topic to publish to for the `kafka` destination. + Required for `kafka`. + example: ampersand-events + x-go-type-skip-optional-pointer: true + saslMechanism: + type: string + description: The SASL mechanism used to authenticate to Kafka for the + `kafka` destination. Required for `kafka`. + enum: [plain, scram-sha-256, scram-sha-512] + example: scram-sha-256 + x-go-type-skip-optional-pointer: true batchSize: type: integer description: For warehouse destinations (`clickhouse`, `snowflake`, @@ -3410,11 +3459,16 @@ paths: - metadata.account - metadata.container - metadata.queueUrl - - metadata.topicArn - metadata.eventBusName - metadata.detailType - metadata.topicId - - metadata.routingKey + - metadata.serverUrl + - metadata.exchange + - metadata.tls + - metadata.name + - metadata.brokers + - metadata.topic + - metadata.saslMechanism - metadata.batchSize - metadata.maxWaitSecs - secrets.awsKeyId @@ -3426,7 +3480,8 @@ paths: - secrets.accessKeyId - secrets.secretAccessKey - secrets.accessKey - - secrets.uri + - secrets.username + - secrets.connectionString example: ["name", "metadata.url", "metadata.region", "metadata.streamName"] destination: @@ -3455,11 +3510,13 @@ paths: example: my-kinesis-stream endpointUrl: type: string - description: The endpoint URL for the Kinesis stream. + description: The endpoint URL for the `kinesis` stream, or the optional + custom endpoint URL for the `sqs` destination. example: https://kinesis.us-east-1.amazonaws.com partitionKeyTemplate: type: string - description: The template for the partition key to use when sending events to Kinesis (a JMESPath template) + description: The template for the partition key (a JMESPath template). + Used by `kinesis`, and optionally by `kafka`. example: "data.user_id" bucket: type: string @@ -3504,6 +3561,7 @@ paths: projectId: type: string description: The Google Cloud project ID (`bigquery`, `pubsub`). + Required for `pubsub`. example: my-gcp-project datasetId: type: string @@ -3536,11 +3594,8 @@ paths: queueUrl: type: string description: The SQS queue URL for the `sqs` destination. + Required for `sqs`. example: https://sqs.us-east-1.amazonaws.com/123456789012/my-queue - topicArn: - type: string - description: The SNS topic ARN for the `sns` destination. - example: arn:aws:sns:us-east-1:123456789012:my-topic eventBusName: type: string description: The EventBridge event bus name for the `eventbridge` destination. @@ -3552,11 +3607,44 @@ paths: topicId: type: string description: The Pub/Sub topic ID for the `pubsub` destination. + Required for `pubsub`. example: ampersand-events - routingKey: + serverUrl: + type: string + description: The AMQP server URL for the `rabbitmq` destination. + Required for `rabbitmq`. + example: amqp://rabbit.example.com:5672 + exchange: type: string - description: The routing key for the `rabbitmq` destination. + description: The exchange to publish to for the `rabbitmq` destination. + Required for `rabbitmq`. example: ampersand.events + tls: + type: boolean + description: Whether to connect over TLS. Optional for the `rabbitmq` + and `kafka` destinations. + example: true + name: + type: string + description: The queue or topic name for the `azureservicebus` destination. + Required for `azureservicebus`. + example: ampersand-events + brokers: + type: string + description: The comma-separated list of Kafka broker addresses for the + `kafka` destination. Required for `kafka`. + example: broker1.example.com:9092,broker2.example.com:9092 + topic: + type: string + description: The Kafka topic to publish to for the `kafka` destination. + Required for `kafka`. + example: ampersand-events + saslMechanism: + type: string + description: The SASL mechanism used to authenticate to Kafka for the + `kafka` destination. Required for `kafka`. + enum: [plain, scram-sha-256, scram-sha-512] + example: scram-sha-256 batchSize: type: integer description: For warehouse destinations, rows to buffer before flushing a batch (default 1000). @@ -3571,19 +3659,23 @@ paths: properties: awsKeyId: type: string - description: The AWS access key ID for the Kinesis or S3 destination. + description: The AWS access key ID for the `kinesis`, `s3`, and `sqs` + destinations. Required for `sqs`. example: AKIAIOSFODNN7EXAMPLE awsSecretKey: type: string - description: The AWS secret access key for the Kinesis or S3 destination. + description: The AWS secret access key for the `kinesis`, `s3`, and `sqs` + destinations. Required for `sqs`. example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY awsSessionToken: type: string - description: The AWS session token for the Kinesis or S3 destination. + description: The optional AWS session token for the `kinesis`, `s3`, and + `sqs` destinations. example: AQoEXAMPLEH4aoAH0gNCAPy... password: type: string - description: The password for the `clickhouse` destination. + description: The password for the `clickhouse`, `rabbitmq`, and `kafka` + destinations. Required for `rabbitmq` and `kafka`. example: my-clickhouse-password privateKey: type: string @@ -3591,24 +3683,30 @@ paths: example: "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----" credentials: type: string - description: The service-account credentials JSON for the `bigquery`, `gcs`, and `pubsub` destinations. + description: The service-account credentials JSON for the `bigquery`, `gcs`, and `pubsub` destinations. Required for `pubsub`. example: '{"type":"service_account", ...}' accessKeyId: type: string - description: The AWS access key ID for the `redshift`, `sqs`, `sns`, and `eventbridge` destinations. + description: The AWS access key ID for the `redshift` and `eventbridge` destinations. example: AKIAIOSFODNN7EXAMPLE secretAccessKey: type: string - description: The AWS secret access key for the `redshift`, `sqs`, `sns`, and `eventbridge` destinations. + description: The AWS secret access key for the `redshift` and `eventbridge` destinations. example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY accessKey: type: string description: The account access key for the `azureblob` destination. example: my-azure-access-key - uri: + username: type: string - description: The connection URI (embeds credentials) for the `rabbitmq` destination. - example: amqp://user:pass@rabbit.example.com:5672 + description: The username for the `rabbitmq` and `kafka` destinations. + Required for both. + example: ampersand + connectionString: + type: string + description: The connection string for the `azureservicebus` destination. + Required for `azureservicebus`. + example: Endpoint=sb://my-namespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=... responses: 404: description: Destination not found @@ -5414,10 +5512,6 @@ components: type: string description: The SQS queue URL for the sqs destination example: https://sqs.us-east-1.amazonaws.com/123456789012/my-queue - topicArn: - type: string - description: The SNS topic ARN for the sns destination - example: arn:aws:sns:us-east-1:123456789012:my-topic eventBusName: type: string description: The EventBridge event bus name for the eventbridge destination @@ -5430,10 +5524,35 @@ components: type: string description: The Pub/Sub topic ID for the pubsub destination example: ampersand-events - routingKey: + serverUrl: + type: string + description: The AMQP server URL for the rabbitmq destination + example: amqp://rabbit.example.com:5672 + exchange: type: string - description: The routing key for the rabbitmq destination + description: The exchange to publish to for the rabbitmq destination example: ampersand.events + tls: + type: boolean + description: Whether to connect over TLS (rabbitmq, kafka) + example: true + name: + type: string + description: The queue or topic name for the azureservicebus destination + example: ampersand-events + brokers: + type: string + description: The comma-separated list of Kafka broker addresses for the kafka destination + example: broker1.example.com:9092,broker2.example.com:9092 + topic: + type: string + description: The Kafka topic to publish to for the kafka destination + example: ampersand-events + saslMechanism: + type: string + description: The SASL mechanism used to authenticate to Kafka for the kafka destination + enum: [plain, scram-sha-256, scram-sha-512] + example: scram-sha-256 batchSize: type: integer description: For warehouse destinations, rows to buffer before flushing a batch (default 1000) @@ -5570,10 +5689,6 @@ components: type: string description: The SQS queue URL for the sqs destination example: https://sqs.us-east-1.amazonaws.com/123456789012/my-queue - topicArn: - type: string - description: The SNS topic ARN for the sns destination - example: arn:aws:sns:us-east-1:123456789012:my-topic eventBusName: type: string description: The EventBridge event bus name for the eventbridge destination @@ -5586,10 +5701,35 @@ components: type: string description: The Pub/Sub topic ID for the pubsub destination example: ampersand-events - routingKey: + serverUrl: type: string - description: The routing key for the rabbitmq destination + description: The AMQP server URL for the rabbitmq destination + example: amqp://rabbit.example.com:5672 + exchange: + type: string + description: The exchange to publish to for the rabbitmq destination example: ampersand.events + tls: + type: boolean + description: Whether to connect over TLS (rabbitmq, kafka) + example: true + name: + type: string + description: The queue or topic name for the azureservicebus destination + example: ampersand-events + brokers: + type: string + description: The comma-separated list of Kafka broker addresses for the kafka destination + example: broker1.example.com:9092,broker2.example.com:9092 + topic: + type: string + description: The Kafka topic to publish to for the kafka destination + example: ampersand-events + saslMechanism: + type: string + description: The SASL mechanism used to authenticate to Kafka for the kafka destination + enum: [plain, scram-sha-256, scram-sha-512] + example: scram-sha-256 batchSize: type: integer description: For warehouse destinations, rows to buffer before flushing a batch (default 1000) diff --git a/api/generated/api.bundled.json b/api/generated/api.bundled.json index 0c4a7a4..1654059 100644 --- a/api/generated/api.bundled.json +++ b/api/generated/api.bundled.json @@ -4469,7 +4469,7 @@ }, "type": { "type": "string", - "description": "The type of the destination. For `slack`, set `metadata.url` to a Slack incoming webhook URL. The warehouse and message-queue types (`clickhouse`, `snowflake`, `bigquery`, `redshift`, `sqs`, `sns`, `eventbridge`, `pubsub`, `rabbitmq`) are configured via the `metadata` and `secrets` fields documented below.", + "description": "The type of the destination. For `slack`, set `metadata.url` to a Slack incoming webhook URL. The warehouse and message-queue types (`clickhouse`, `snowflake`, `bigquery`, `redshift`, `sqs`, `eventbridge`, `pubsub`, `rabbitmq`, `azureservicebus`, `kafka`) are configured via the `metadata` and `secrets` fields documented below.", "example": "webhook", "enum": [ "webhook", @@ -4481,10 +4481,11 @@ "bigquery", "redshift", "sqs", - "sns", "eventbridge", "pubsub", - "rabbitmq" + "rabbitmq", + "azureservicebus", + "kafka" ] }, "secrets": { @@ -4493,25 +4494,25 @@ "properties": { "awsKeyId": { "type": "string", - "description": "The AWS access key ID for the Kinesis or S3 destination.", + "description": "The AWS access key ID for the `kinesis`, `s3`, and `sqs` destinations. Required for `sqs`.", "example": "AKIAIOSFODNN7EXAMPLE", "x-go-type-skip-optional-pointer": true }, "awsSecretKey": { "type": "string", - "description": "The AWS secret access key for the Kinesis or S3 destination.", + "description": "The AWS secret access key for the `kinesis`, `s3`, and `sqs` destinations. Required for `sqs`.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "x-go-type-skip-optional-pointer": true }, "awsSessionToken": { "type": "string", - "description": "The AWS session token for the Kinesis or S3 destination.", + "description": "The optional AWS session token for the `kinesis`, `s3`, and `sqs` destinations.", "example": "AQoEXAMPLEH4aoAH0gNCAPy...", "x-go-type-skip-optional-pointer": true }, "password": { "type": "string", - "description": "The password for the `clickhouse` destination.", + "description": "The password for the `clickhouse`, `rabbitmq`, and `kafka` destinations. Required for `rabbitmq` and `kafka`.", "example": "my-clickhouse-password", "x-go-type-skip-optional-pointer": true }, @@ -4523,19 +4524,19 @@ }, "credentials": { "type": "string", - "description": "The service-account credentials JSON for the `bigquery`, `gcs`, and `pubsub` destinations.", + "description": "The service-account credentials JSON for the `bigquery`, `gcs`, and `pubsub` destinations. Required for `pubsub`.", "example": "{\"type\":\"service_account\", ...}", "x-go-type-skip-optional-pointer": true }, "accessKeyId": { "type": "string", - "description": "The AWS access key ID for the `redshift`, `sqs`, `sns`, and `eventbridge` destinations.", + "description": "The AWS access key ID for the `redshift` and `eventbridge` destinations.", "example": "AKIAIOSFODNN7EXAMPLE", "x-go-type-skip-optional-pointer": true }, "secretAccessKey": { "type": "string", - "description": "The AWS secret access key for the `redshift`, `sqs`, `sns`, and `eventbridge` destinations.", + "description": "The AWS secret access key for the `redshift` and `eventbridge` destinations.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "x-go-type-skip-optional-pointer": true }, @@ -4545,10 +4546,16 @@ "example": "my-azure-access-key", "x-go-type-skip-optional-pointer": true }, - "uri": { + "username": { + "type": "string", + "description": "The username for the `rabbitmq` and `kafka` destinations. Required for both.", + "example": "ampersand", + "x-go-type-skip-optional-pointer": true + }, + "connectionString": { "type": "string", - "description": "The connection URI (embeds credentials) for the `rabbitmq` destination.", - "example": "amqp://user:pass@rabbit.example.com:5672", + "description": "The connection string for the `azureservicebus` destination. Required for `azureservicebus`.", + "example": "Endpoint=sb://my-namespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=...", "x-go-type-skip-optional-pointer": true } } @@ -4578,13 +4585,13 @@ }, "endpointUrl": { "type": "string", - "description": "The endpoint URL for the Kinesis stream.", + "description": "The endpoint URL for the `kinesis` stream, or the optional custom endpoint URL for the `sqs` destination.", "example": "https://kinesis.us-east-1.amazonaws.com", "x-go-type-skip-optional-pointer": true }, "partitionKeyTemplate": { "type": "string", - "description": "The template for the partition key to use when sending events to Kinesis (a JMESPath template)", + "description": "The template for the partition key (a JMESPath template). Used by `kinesis`, and optionally by `kafka`.", "example": "data.user_id", "x-go-type-skip-optional-pointer": true }, @@ -4650,7 +4657,7 @@ }, "projectId": { "type": "string", - "description": "The Google Cloud project ID (`bigquery`, `pubsub`).", + "description": "The Google Cloud project ID (`bigquery`, `pubsub`). Required for `pubsub`.", "example": "my-gcp-project", "x-go-type-skip-optional-pointer": true }, @@ -4698,16 +4705,10 @@ }, "queueUrl": { "type": "string", - "description": "The SQS queue URL for the `sqs` destination.", + "description": "The SQS queue URL for the `sqs` destination. Required for `sqs`.", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue", "x-go-type-skip-optional-pointer": true }, - "topicArn": { - "type": "string", - "description": "The SNS topic ARN for the `sns` destination.", - "example": "arn:aws:sns:us-east-1:123456789012:my-topic", - "x-go-type-skip-optional-pointer": true - }, "eventBusName": { "type": "string", "description": "The EventBridge event bus name for the `eventbridge` destination.", @@ -4722,16 +4723,57 @@ }, "topicId": { "type": "string", - "description": "The Pub/Sub topic ID for the `pubsub` destination.", + "description": "The Pub/Sub topic ID for the `pubsub` destination. Required for `pubsub`.", "example": "ampersand-events", "x-go-type-skip-optional-pointer": true }, - "routingKey": { + "serverUrl": { + "type": "string", + "description": "The AMQP server URL for the `rabbitmq` destination. Required for `rabbitmq`.", + "example": "amqp://rabbit.example.com:5672", + "x-go-type-skip-optional-pointer": true + }, + "exchange": { "type": "string", - "description": "The routing key for the `rabbitmq` destination.", + "description": "The exchange to publish to for the `rabbitmq` destination. Required for `rabbitmq`.", "example": "ampersand.events", "x-go-type-skip-optional-pointer": true }, + "tls": { + "type": "boolean", + "description": "Whether to connect over TLS. Optional for the `rabbitmq` and `kafka` destinations.", + "example": true, + "x-go-type-skip-optional-pointer": true + }, + "name": { + "type": "string", + "description": "The queue or topic name for the `azureservicebus` destination. Required for `azureservicebus`.", + "example": "ampersand-events", + "x-go-type-skip-optional-pointer": true + }, + "brokers": { + "type": "string", + "description": "The comma-separated list of Kafka broker addresses for the `kafka` destination. Required for `kafka`.", + "example": "broker1.example.com:9092,broker2.example.com:9092", + "x-go-type-skip-optional-pointer": true + }, + "topic": { + "type": "string", + "description": "The Kafka topic to publish to for the `kafka` destination. Required for `kafka`.", + "example": "ampersand-events", + "x-go-type-skip-optional-pointer": true + }, + "saslMechanism": { + "type": "string", + "description": "The SASL mechanism used to authenticate to Kafka for the `kafka` destination. Required for `kafka`.", + "enum": [ + "plain", + "scram-sha-256", + "scram-sha-512" + ], + "example": "scram-sha-256", + "x-go-type-skip-optional-pointer": true + }, "batchSize": { "type": "integer", "description": "For warehouse destinations (`clickhouse`, `snowflake`, `bigquery`, `redshift`), the number of rows to buffer before flushing a batch. Defaults to 1000.", @@ -4965,7 +5007,7 @@ "items": { "type": "string" }, - "description": "Array of field paths specifying which fields to update. Allowed values include:\n- name\n- metadata.url\n- metadata.headers\n- metadata.region\n- metadata.streamName\n- metadata.endpointUrl\n- metadata.partitionKeyTemplate\n- metadata.bucket\n- metadata.keyTemplate\n- metadata.storageClass\n- metadata.username\n- metadata.tableName\n- metadata.database\n- metadata.accountIdentifier\n- metadata.userId\n- metadata.dbName\n- metadata.schemaName\n- metadata.projectId\n- metadata.datasetId\n- metadata.tableId\n- metadata.workgroupName\n- metadata.clusterIdentifier\n- metadata.dbUser\n- metadata.account\n- metadata.container\n- metadata.queueUrl\n- metadata.topicArn\n- metadata.eventBusName\n- metadata.detailType\n- metadata.topicId\n- metadata.routingKey\n- metadata.batchSize\n- metadata.maxWaitSecs\n- secrets.awsKeyId\n- secrets.awsSecretKey\n- secrets.awsSessionToken\n- secrets.password\n- secrets.privateKey\n- secrets.credentials\n- secrets.accessKeyId\n- secrets.secretAccessKey\n- secrets.accessKey\n- secrets.uri\n", + "description": "Array of field paths specifying which fields to update. Allowed values include:\n- name\n- metadata.url\n- metadata.headers\n- metadata.region\n- metadata.streamName\n- metadata.endpointUrl\n- metadata.partitionKeyTemplate\n- metadata.bucket\n- metadata.keyTemplate\n- metadata.storageClass\n- metadata.username\n- metadata.tableName\n- metadata.database\n- metadata.accountIdentifier\n- metadata.userId\n- metadata.dbName\n- metadata.schemaName\n- metadata.projectId\n- metadata.datasetId\n- metadata.tableId\n- metadata.workgroupName\n- metadata.clusterIdentifier\n- metadata.dbUser\n- metadata.account\n- metadata.container\n- metadata.queueUrl\n- metadata.eventBusName\n- metadata.detailType\n- metadata.topicId\n- metadata.serverUrl\n- metadata.exchange\n- metadata.tls\n- metadata.name\n- metadata.brokers\n- metadata.topic\n- metadata.saslMechanism\n- metadata.batchSize\n- metadata.maxWaitSecs\n- secrets.awsKeyId\n- secrets.awsSecretKey\n- secrets.awsSessionToken\n- secrets.password\n- secrets.privateKey\n- secrets.credentials\n- secrets.accessKeyId\n- secrets.secretAccessKey\n- secrets.accessKey\n- secrets.username\n- secrets.connectionString\n", "example": [ "name", "metadata.url", @@ -5004,12 +5046,12 @@ }, "endpointUrl": { "type": "string", - "description": "The endpoint URL for the Kinesis stream.", + "description": "The endpoint URL for the `kinesis` stream, or the optional custom endpoint URL for the `sqs` destination.", "example": "https://kinesis.us-east-1.amazonaws.com" }, "partitionKeyTemplate": { "type": "string", - "description": "The template for the partition key to use when sending events to Kinesis (a JMESPath template)", + "description": "The template for the partition key (a JMESPath template). Used by `kinesis`, and optionally by `kafka`.", "example": "data.user_id" }, "bucket": { @@ -5064,7 +5106,7 @@ }, "projectId": { "type": "string", - "description": "The Google Cloud project ID (`bigquery`, `pubsub`).", + "description": "The Google Cloud project ID (`bigquery`, `pubsub`). Required for `pubsub`.", "example": "my-gcp-project" }, "datasetId": { @@ -5104,14 +5146,9 @@ }, "queueUrl": { "type": "string", - "description": "The SQS queue URL for the `sqs` destination.", + "description": "The SQS queue URL for the `sqs` destination. Required for `sqs`.", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue" }, - "topicArn": { - "type": "string", - "description": "The SNS topic ARN for the `sns` destination.", - "example": "arn:aws:sns:us-east-1:123456789012:my-topic" - }, "eventBusName": { "type": "string", "description": "The EventBridge event bus name for the `eventbridge` destination.", @@ -5124,14 +5161,49 @@ }, "topicId": { "type": "string", - "description": "The Pub/Sub topic ID for the `pubsub` destination.", + "description": "The Pub/Sub topic ID for the `pubsub` destination. Required for `pubsub`.", "example": "ampersand-events" }, - "routingKey": { + "serverUrl": { "type": "string", - "description": "The routing key for the `rabbitmq` destination.", + "description": "The AMQP server URL for the `rabbitmq` destination. Required for `rabbitmq`.", + "example": "amqp://rabbit.example.com:5672" + }, + "exchange": { + "type": "string", + "description": "The exchange to publish to for the `rabbitmq` destination. Required for `rabbitmq`.", "example": "ampersand.events" }, + "tls": { + "type": "boolean", + "description": "Whether to connect over TLS. Optional for the `rabbitmq` and `kafka` destinations.", + "example": true + }, + "name": { + "type": "string", + "description": "The queue or topic name for the `azureservicebus` destination. Required for `azureservicebus`.", + "example": "ampersand-events" + }, + "brokers": { + "type": "string", + "description": "The comma-separated list of Kafka broker addresses for the `kafka` destination. Required for `kafka`.", + "example": "broker1.example.com:9092,broker2.example.com:9092" + }, + "topic": { + "type": "string", + "description": "The Kafka topic to publish to for the `kafka` destination. Required for `kafka`.", + "example": "ampersand-events" + }, + "saslMechanism": { + "type": "string", + "description": "The SASL mechanism used to authenticate to Kafka for the `kafka` destination. Required for `kafka`.", + "enum": [ + "plain", + "scram-sha-256", + "scram-sha-512" + ], + "example": "scram-sha-256" + }, "batchSize": { "type": "integer", "description": "For warehouse destinations, rows to buffer before flushing a batch (default 1000).", @@ -5150,22 +5222,22 @@ "properties": { "awsKeyId": { "type": "string", - "description": "The AWS access key ID for the Kinesis or S3 destination.", + "description": "The AWS access key ID for the `kinesis`, `s3`, and `sqs` destinations. Required for `sqs`.", "example": "AKIAIOSFODNN7EXAMPLE" }, "awsSecretKey": { "type": "string", - "description": "The AWS secret access key for the Kinesis or S3 destination.", + "description": "The AWS secret access key for the `kinesis`, `s3`, and `sqs` destinations. Required for `sqs`.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" }, "awsSessionToken": { "type": "string", - "description": "The AWS session token for the Kinesis or S3 destination.", + "description": "The optional AWS session token for the `kinesis`, `s3`, and `sqs` destinations.", "example": "AQoEXAMPLEH4aoAH0gNCAPy..." }, "password": { "type": "string", - "description": "The password for the `clickhouse` destination.", + "description": "The password for the `clickhouse`, `rabbitmq`, and `kafka` destinations. Required for `rabbitmq` and `kafka`.", "example": "my-clickhouse-password" }, "privateKey": { @@ -5175,17 +5247,17 @@ }, "credentials": { "type": "string", - "description": "The service-account credentials JSON for the `bigquery`, `gcs`, and `pubsub` destinations.", + "description": "The service-account credentials JSON for the `bigquery`, `gcs`, and `pubsub` destinations. Required for `pubsub`.", "example": "{\"type\":\"service_account\", ...}" }, "accessKeyId": { "type": "string", - "description": "The AWS access key ID for the `redshift`, `sqs`, `sns`, and `eventbridge` destinations.", + "description": "The AWS access key ID for the `redshift` and `eventbridge` destinations.", "example": "AKIAIOSFODNN7EXAMPLE" }, "secretAccessKey": { "type": "string", - "description": "The AWS secret access key for the `redshift`, `sqs`, `sns`, and `eventbridge` destinations.", + "description": "The AWS secret access key for the `redshift` and `eventbridge` destinations.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" }, "accessKey": { @@ -5193,10 +5265,15 @@ "description": "The account access key for the `azureblob` destination.", "example": "my-azure-access-key" }, - "uri": { + "username": { + "type": "string", + "description": "The username for the `rabbitmq` and `kafka` destinations. Required for both.", + "example": "ampersand" + }, + "connectionString": { "type": "string", - "description": "The connection URI (embeds credentials) for the `rabbitmq` destination.", - "example": "amqp://user:pass@rabbit.example.com:5672" + "description": "The connection string for the `azureservicebus` destination. Required for `azureservicebus`.", + "example": "Endpoint=sb://my-namespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=..." } } } @@ -7988,11 +8065,6 @@ "description": "The SQS queue URL for the sqs destination", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue" }, - "topicArn": { - "type": "string", - "description": "The SNS topic ARN for the sns destination", - "example": "arn:aws:sns:us-east-1:123456789012:my-topic" - }, "eventBusName": { "type": "string", "description": "The EventBridge event bus name for the eventbridge destination", @@ -8008,11 +8080,46 @@ "description": "The Pub/Sub topic ID for the pubsub destination", "example": "ampersand-events" }, - "routingKey": { + "serverUrl": { + "type": "string", + "description": "The AMQP server URL for the rabbitmq destination", + "example": "amqp://rabbit.example.com:5672" + }, + "exchange": { "type": "string", - "description": "The routing key for the rabbitmq destination", + "description": "The exchange to publish to for the rabbitmq destination", "example": "ampersand.events" }, + "tls": { + "type": "boolean", + "description": "Whether to connect over TLS (rabbitmq, kafka)", + "example": true + }, + "name": { + "type": "string", + "description": "The queue or topic name for the azureservicebus destination", + "example": "ampersand-events" + }, + "brokers": { + "type": "string", + "description": "The comma-separated list of Kafka broker addresses for the kafka destination", + "example": "broker1.example.com:9092,broker2.example.com:9092" + }, + "topic": { + "type": "string", + "description": "The Kafka topic to publish to for the kafka destination", + "example": "ampersand-events" + }, + "saslMechanism": { + "type": "string", + "description": "The SASL mechanism used to authenticate to Kafka for the kafka destination", + "enum": [ + "plain", + "scram-sha-256", + "scram-sha-512" + ], + "example": "scram-sha-256" + }, "batchSize": { "type": "integer", "description": "For warehouse destinations, rows to buffer before flushing a batch (default 1000)", @@ -8184,11 +8291,6 @@ "description": "The SQS queue URL for the sqs destination", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue" }, - "topicArn": { - "type": "string", - "description": "The SNS topic ARN for the sns destination", - "example": "arn:aws:sns:us-east-1:123456789012:my-topic" - }, "eventBusName": { "type": "string", "description": "The EventBridge event bus name for the eventbridge destination", @@ -8204,11 +8306,46 @@ "description": "The Pub/Sub topic ID for the pubsub destination", "example": "ampersand-events" }, - "routingKey": { + "serverUrl": { + "type": "string", + "description": "The AMQP server URL for the rabbitmq destination", + "example": "amqp://rabbit.example.com:5672" + }, + "exchange": { "type": "string", - "description": "The routing key for the rabbitmq destination", + "description": "The exchange to publish to for the rabbitmq destination", "example": "ampersand.events" }, + "tls": { + "type": "boolean", + "description": "Whether to connect over TLS (rabbitmq, kafka)", + "example": true + }, + "name": { + "type": "string", + "description": "The queue or topic name for the azureservicebus destination", + "example": "ampersand-events" + }, + "brokers": { + "type": "string", + "description": "The comma-separated list of Kafka broker addresses for the kafka destination", + "example": "broker1.example.com:9092,broker2.example.com:9092" + }, + "topic": { + "type": "string", + "description": "The Kafka topic to publish to for the kafka destination", + "example": "ampersand-events" + }, + "saslMechanism": { + "type": "string", + "description": "The SASL mechanism used to authenticate to Kafka for the kafka destination", + "enum": [ + "plain", + "scram-sha-256", + "scram-sha-512" + ], + "example": "scram-sha-256" + }, "batchSize": { "type": "integer", "description": "For warehouse destinations, rows to buffer before flushing a batch (default 1000)", diff --git a/api/generated/api.json b/api/generated/api.json index af2336a..df4cfe6 100644 --- a/api/generated/api.json +++ b/api/generated/api.json @@ -48971,7 +48971,7 @@ }, "type": { "type": "string", - "description": "The type of the destination. For `slack`, set `metadata.url` to a Slack incoming webhook URL. The warehouse and message-queue types (`clickhouse`, `snowflake`, `bigquery`, `redshift`, `sqs`, `sns`, `eventbridge`, `pubsub`, `rabbitmq`) are configured via the `metadata` and `secrets` fields documented below.", + "description": "The type of the destination. For `slack`, set `metadata.url` to a Slack incoming webhook URL. The warehouse and message-queue types (`clickhouse`, `snowflake`, `bigquery`, `redshift`, `sqs`, `eventbridge`, `pubsub`, `rabbitmq`, `azureservicebus`, `kafka`) are configured via the `metadata` and `secrets` fields documented below.", "example": "webhook", "enum": [ "webhook", @@ -48983,10 +48983,11 @@ "bigquery", "redshift", "sqs", - "sns", "eventbridge", "pubsub", - "rabbitmq" + "rabbitmq", + "azureservicebus", + "kafka" ] }, "secrets": { @@ -48995,25 +48996,25 @@ "properties": { "awsKeyId": { "type": "string", - "description": "The AWS access key ID for the Kinesis or S3 destination.", + "description": "The AWS access key ID for the `kinesis`, `s3`, and `sqs` destinations. Required for `sqs`.", "example": "AKIAIOSFODNN7EXAMPLE", "x-go-type-skip-optional-pointer": true }, "awsSecretKey": { "type": "string", - "description": "The AWS secret access key for the Kinesis or S3 destination.", + "description": "The AWS secret access key for the `kinesis`, `s3`, and `sqs` destinations. Required for `sqs`.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "x-go-type-skip-optional-pointer": true }, "awsSessionToken": { "type": "string", - "description": "The AWS session token for the Kinesis or S3 destination.", + "description": "The optional AWS session token for the `kinesis`, `s3`, and `sqs` destinations.", "example": "AQoEXAMPLEH4aoAH0gNCAPy...", "x-go-type-skip-optional-pointer": true }, "password": { "type": "string", - "description": "The password for the `clickhouse` destination.", + "description": "The password for the `clickhouse`, `rabbitmq`, and `kafka` destinations. Required for `rabbitmq` and `kafka`.", "example": "my-clickhouse-password", "x-go-type-skip-optional-pointer": true }, @@ -49025,19 +49026,19 @@ }, "credentials": { "type": "string", - "description": "The service-account credentials JSON for the `bigquery`, `gcs`, and `pubsub` destinations.", + "description": "The service-account credentials JSON for the `bigquery`, `gcs`, and `pubsub` destinations. Required for `pubsub`.", "example": "{\"type\":\"service_account\", ...}", "x-go-type-skip-optional-pointer": true }, "accessKeyId": { "type": "string", - "description": "The AWS access key ID for the `redshift`, `sqs`, `sns`, and `eventbridge` destinations.", + "description": "The AWS access key ID for the `redshift` and `eventbridge` destinations.", "example": "AKIAIOSFODNN7EXAMPLE", "x-go-type-skip-optional-pointer": true }, "secretAccessKey": { "type": "string", - "description": "The AWS secret access key for the `redshift`, `sqs`, `sns`, and `eventbridge` destinations.", + "description": "The AWS secret access key for the `redshift` and `eventbridge` destinations.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "x-go-type-skip-optional-pointer": true }, @@ -49047,10 +49048,16 @@ "example": "my-azure-access-key", "x-go-type-skip-optional-pointer": true }, - "uri": { + "username": { + "type": "string", + "description": "The username for the `rabbitmq` and `kafka` destinations. Required for both.", + "example": "ampersand", + "x-go-type-skip-optional-pointer": true + }, + "connectionString": { "type": "string", - "description": "The connection URI (embeds credentials) for the `rabbitmq` destination.", - "example": "amqp://user:pass@rabbit.example.com:5672", + "description": "The connection string for the `azureservicebus` destination. Required for `azureservicebus`.", + "example": "Endpoint=sb://my-namespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=...", "x-go-type-skip-optional-pointer": true } } @@ -49090,13 +49097,13 @@ }, "endpointUrl": { "type": "string", - "description": "The endpoint URL for the Kinesis stream.", + "description": "The endpoint URL for the `kinesis` stream, or the optional custom endpoint URL for the `sqs` destination.", "example": "https://kinesis.us-east-1.amazonaws.com", "x-go-type-skip-optional-pointer": true }, "partitionKeyTemplate": { "type": "string", - "description": "The template for the partition key to use when sending events to Kinesis (a JMESPath template)", + "description": "The template for the partition key (a JMESPath template). Used by `kinesis`, and optionally by `kafka`.", "example": "data.user_id", "x-go-type-skip-optional-pointer": true }, @@ -49162,7 +49169,7 @@ }, "projectId": { "type": "string", - "description": "The Google Cloud project ID (`bigquery`, `pubsub`).", + "description": "The Google Cloud project ID (`bigquery`, `pubsub`). Required for `pubsub`.", "example": "my-gcp-project", "x-go-type-skip-optional-pointer": true }, @@ -49210,16 +49217,10 @@ }, "queueUrl": { "type": "string", - "description": "The SQS queue URL for the `sqs` destination.", + "description": "The SQS queue URL for the `sqs` destination. Required for `sqs`.", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue", "x-go-type-skip-optional-pointer": true }, - "topicArn": { - "type": "string", - "description": "The SNS topic ARN for the `sns` destination.", - "example": "arn:aws:sns:us-east-1:123456789012:my-topic", - "x-go-type-skip-optional-pointer": true - }, "eventBusName": { "type": "string", "description": "The EventBridge event bus name for the `eventbridge` destination.", @@ -49234,16 +49235,57 @@ }, "topicId": { "type": "string", - "description": "The Pub/Sub topic ID for the `pubsub` destination.", + "description": "The Pub/Sub topic ID for the `pubsub` destination. Required for `pubsub`.", "example": "ampersand-events", "x-go-type-skip-optional-pointer": true }, - "routingKey": { + "serverUrl": { + "type": "string", + "description": "The AMQP server URL for the `rabbitmq` destination. Required for `rabbitmq`.", + "example": "amqp://rabbit.example.com:5672", + "x-go-type-skip-optional-pointer": true + }, + "exchange": { "type": "string", - "description": "The routing key for the `rabbitmq` destination.", + "description": "The exchange to publish to for the `rabbitmq` destination. Required for `rabbitmq`.", "example": "ampersand.events", "x-go-type-skip-optional-pointer": true }, + "tls": { + "type": "boolean", + "description": "Whether to connect over TLS. Optional for the `rabbitmq` and `kafka` destinations.", + "example": true, + "x-go-type-skip-optional-pointer": true + }, + "name": { + "type": "string", + "description": "The queue or topic name for the `azureservicebus` destination. Required for `azureservicebus`.", + "example": "ampersand-events", + "x-go-type-skip-optional-pointer": true + }, + "brokers": { + "type": "string", + "description": "The comma-separated list of Kafka broker addresses for the `kafka` destination. Required for `kafka`.", + "example": "broker1.example.com:9092,broker2.example.com:9092", + "x-go-type-skip-optional-pointer": true + }, + "topic": { + "type": "string", + "description": "The Kafka topic to publish to for the `kafka` destination. Required for `kafka`.", + "example": "ampersand-events", + "x-go-type-skip-optional-pointer": true + }, + "saslMechanism": { + "type": "string", + "description": "The SASL mechanism used to authenticate to Kafka for the `kafka` destination. Required for `kafka`.", + "enum": [ + "plain", + "scram-sha-256", + "scram-sha-512" + ], + "example": "scram-sha-256", + "x-go-type-skip-optional-pointer": true + }, "batchSize": { "type": "integer", "description": "For warehouse destinations (`clickhouse`, `snowflake`, `bigquery`, `redshift`), the number of rows to buffer before flushing a batch. Defaults to 1000.", @@ -49424,11 +49466,6 @@ "description": "The SQS queue URL for the sqs destination", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue" }, - "topicArn": { - "type": "string", - "description": "The SNS topic ARN for the sns destination", - "example": "arn:aws:sns:us-east-1:123456789012:my-topic" - }, "eventBusName": { "type": "string", "description": "The EventBridge event bus name for the eventbridge destination", @@ -49444,11 +49481,46 @@ "description": "The Pub/Sub topic ID for the pubsub destination", "example": "ampersand-events" }, - "routingKey": { + "serverUrl": { + "type": "string", + "description": "The AMQP server URL for the rabbitmq destination", + "example": "amqp://rabbit.example.com:5672" + }, + "exchange": { "type": "string", - "description": "The routing key for the rabbitmq destination", + "description": "The exchange to publish to for the rabbitmq destination", "example": "ampersand.events" }, + "tls": { + "type": "boolean", + "description": "Whether to connect over TLS (rabbitmq, kafka)", + "example": true + }, + "name": { + "type": "string", + "description": "The queue or topic name for the azureservicebus destination", + "example": "ampersand-events" + }, + "brokers": { + "type": "string", + "description": "The comma-separated list of Kafka broker addresses for the kafka destination", + "example": "broker1.example.com:9092,broker2.example.com:9092" + }, + "topic": { + "type": "string", + "description": "The Kafka topic to publish to for the kafka destination", + "example": "ampersand-events" + }, + "saslMechanism": { + "type": "string", + "description": "The SASL mechanism used to authenticate to Kafka for the kafka destination", + "enum": [ + "plain", + "scram-sha-256", + "scram-sha-512" + ], + "example": "scram-sha-256" + }, "batchSize": { "type": "integer", "description": "For warehouse destinations, rows to buffer before flushing a batch (default 1000)", @@ -50443,11 +50515,6 @@ "description": "The SQS queue URL for the sqs destination", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue" }, - "topicArn": { - "type": "string", - "description": "The SNS topic ARN for the sns destination", - "example": "arn:aws:sns:us-east-1:123456789012:my-topic" - }, "eventBusName": { "type": "string", "description": "The EventBridge event bus name for the eventbridge destination", @@ -50463,11 +50530,46 @@ "description": "The Pub/Sub topic ID for the pubsub destination", "example": "ampersand-events" }, - "routingKey": { + "serverUrl": { + "type": "string", + "description": "The AMQP server URL for the rabbitmq destination", + "example": "amqp://rabbit.example.com:5672" + }, + "exchange": { "type": "string", - "description": "The routing key for the rabbitmq destination", + "description": "The exchange to publish to for the rabbitmq destination", "example": "ampersand.events" }, + "tls": { + "type": "boolean", + "description": "Whether to connect over TLS (rabbitmq, kafka)", + "example": true + }, + "name": { + "type": "string", + "description": "The queue or topic name for the azureservicebus destination", + "example": "ampersand-events" + }, + "brokers": { + "type": "string", + "description": "The comma-separated list of Kafka broker addresses for the kafka destination", + "example": "broker1.example.com:9092,broker2.example.com:9092" + }, + "topic": { + "type": "string", + "description": "The Kafka topic to publish to for the kafka destination", + "example": "ampersand-events" + }, + "saslMechanism": { + "type": "string", + "description": "The SASL mechanism used to authenticate to Kafka for the kafka destination", + "enum": [ + "plain", + "scram-sha-256", + "scram-sha-512" + ], + "example": "scram-sha-256" + }, "batchSize": { "type": "integer", "description": "For warehouse destinations, rows to buffer before flushing a batch (default 1000)", @@ -50845,11 +50947,6 @@ "description": "The SQS queue URL for the sqs destination", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue" }, - "topicArn": { - "type": "string", - "description": "The SNS topic ARN for the sns destination", - "example": "arn:aws:sns:us-east-1:123456789012:my-topic" - }, "eventBusName": { "type": "string", "description": "The EventBridge event bus name for the eventbridge destination", @@ -50865,11 +50962,46 @@ "description": "The Pub/Sub topic ID for the pubsub destination", "example": "ampersand-events" }, - "routingKey": { + "serverUrl": { "type": "string", - "description": "The routing key for the rabbitmq destination", + "description": "The AMQP server URL for the rabbitmq destination", + "example": "amqp://rabbit.example.com:5672" + }, + "exchange": { + "type": "string", + "description": "The exchange to publish to for the rabbitmq destination", "example": "ampersand.events" }, + "tls": { + "type": "boolean", + "description": "Whether to connect over TLS (rabbitmq, kafka)", + "example": true + }, + "name": { + "type": "string", + "description": "The queue or topic name for the azureservicebus destination", + "example": "ampersand-events" + }, + "brokers": { + "type": "string", + "description": "The comma-separated list of Kafka broker addresses for the kafka destination", + "example": "broker1.example.com:9092,broker2.example.com:9092" + }, + "topic": { + "type": "string", + "description": "The Kafka topic to publish to for the kafka destination", + "example": "ampersand-events" + }, + "saslMechanism": { + "type": "string", + "description": "The SASL mechanism used to authenticate to Kafka for the kafka destination", + "enum": [ + "plain", + "scram-sha-256", + "scram-sha-512" + ], + "example": "scram-sha-256" + }, "batchSize": { "type": "integer", "description": "For warehouse destinations, rows to buffer before flushing a batch (default 1000)", @@ -51411,7 +51543,7 @@ "items": { "type": "string" }, - "description": "Array of field paths specifying which fields to update. Allowed values include:\n- name\n- metadata.url\n- metadata.headers\n- metadata.region\n- metadata.streamName\n- metadata.endpointUrl\n- metadata.partitionKeyTemplate\n- metadata.bucket\n- metadata.keyTemplate\n- metadata.storageClass\n- metadata.username\n- metadata.tableName\n- metadata.database\n- metadata.accountIdentifier\n- metadata.userId\n- metadata.dbName\n- metadata.schemaName\n- metadata.projectId\n- metadata.datasetId\n- metadata.tableId\n- metadata.workgroupName\n- metadata.clusterIdentifier\n- metadata.dbUser\n- metadata.account\n- metadata.container\n- metadata.queueUrl\n- metadata.topicArn\n- metadata.eventBusName\n- metadata.detailType\n- metadata.topicId\n- metadata.routingKey\n- metadata.batchSize\n- metadata.maxWaitSecs\n- secrets.awsKeyId\n- secrets.awsSecretKey\n- secrets.awsSessionToken\n- secrets.password\n- secrets.privateKey\n- secrets.credentials\n- secrets.accessKeyId\n- secrets.secretAccessKey\n- secrets.accessKey\n- secrets.uri\n", + "description": "Array of field paths specifying which fields to update. Allowed values include:\n- name\n- metadata.url\n- metadata.headers\n- metadata.region\n- metadata.streamName\n- metadata.endpointUrl\n- metadata.partitionKeyTemplate\n- metadata.bucket\n- metadata.keyTemplate\n- metadata.storageClass\n- metadata.username\n- metadata.tableName\n- metadata.database\n- metadata.accountIdentifier\n- metadata.userId\n- metadata.dbName\n- metadata.schemaName\n- metadata.projectId\n- metadata.datasetId\n- metadata.tableId\n- metadata.workgroupName\n- metadata.clusterIdentifier\n- metadata.dbUser\n- metadata.account\n- metadata.container\n- metadata.queueUrl\n- metadata.eventBusName\n- metadata.detailType\n- metadata.topicId\n- metadata.serverUrl\n- metadata.exchange\n- metadata.tls\n- metadata.name\n- metadata.brokers\n- metadata.topic\n- metadata.saslMechanism\n- metadata.batchSize\n- metadata.maxWaitSecs\n- secrets.awsKeyId\n- secrets.awsSecretKey\n- secrets.awsSessionToken\n- secrets.password\n- secrets.privateKey\n- secrets.credentials\n- secrets.accessKeyId\n- secrets.secretAccessKey\n- secrets.accessKey\n- secrets.username\n- secrets.connectionString\n", "example": [ "name", "metadata.url", @@ -51460,12 +51592,12 @@ }, "endpointUrl": { "type": "string", - "description": "The endpoint URL for the Kinesis stream.", + "description": "The endpoint URL for the `kinesis` stream, or the optional custom endpoint URL for the `sqs` destination.", "example": "https://kinesis.us-east-1.amazonaws.com" }, "partitionKeyTemplate": { "type": "string", - "description": "The template for the partition key to use when sending events to Kinesis (a JMESPath template)", + "description": "The template for the partition key (a JMESPath template). Used by `kinesis`, and optionally by `kafka`.", "example": "data.user_id" }, "bucket": { @@ -51520,7 +51652,7 @@ }, "projectId": { "type": "string", - "description": "The Google Cloud project ID (`bigquery`, `pubsub`).", + "description": "The Google Cloud project ID (`bigquery`, `pubsub`). Required for `pubsub`.", "example": "my-gcp-project" }, "datasetId": { @@ -51560,14 +51692,9 @@ }, "queueUrl": { "type": "string", - "description": "The SQS queue URL for the `sqs` destination.", + "description": "The SQS queue URL for the `sqs` destination. Required for `sqs`.", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue" }, - "topicArn": { - "type": "string", - "description": "The SNS topic ARN for the `sns` destination.", - "example": "arn:aws:sns:us-east-1:123456789012:my-topic" - }, "eventBusName": { "type": "string", "description": "The EventBridge event bus name for the `eventbridge` destination.", @@ -51580,14 +51707,49 @@ }, "topicId": { "type": "string", - "description": "The Pub/Sub topic ID for the `pubsub` destination.", + "description": "The Pub/Sub topic ID for the `pubsub` destination. Required for `pubsub`.", "example": "ampersand-events" }, - "routingKey": { + "serverUrl": { "type": "string", - "description": "The routing key for the `rabbitmq` destination.", + "description": "The AMQP server URL for the `rabbitmq` destination. Required for `rabbitmq`.", + "example": "amqp://rabbit.example.com:5672" + }, + "exchange": { + "type": "string", + "description": "The exchange to publish to for the `rabbitmq` destination. Required for `rabbitmq`.", "example": "ampersand.events" }, + "tls": { + "type": "boolean", + "description": "Whether to connect over TLS. Optional for the `rabbitmq` and `kafka` destinations.", + "example": true + }, + "name": { + "type": "string", + "description": "The queue or topic name for the `azureservicebus` destination. Required for `azureservicebus`.", + "example": "ampersand-events" + }, + "brokers": { + "type": "string", + "description": "The comma-separated list of Kafka broker addresses for the `kafka` destination. Required for `kafka`.", + "example": "broker1.example.com:9092,broker2.example.com:9092" + }, + "topic": { + "type": "string", + "description": "The Kafka topic to publish to for the `kafka` destination. Required for `kafka`.", + "example": "ampersand-events" + }, + "saslMechanism": { + "type": "string", + "description": "The SASL mechanism used to authenticate to Kafka for the `kafka` destination. Required for `kafka`.", + "enum": [ + "plain", + "scram-sha-256", + "scram-sha-512" + ], + "example": "scram-sha-256" + }, "batchSize": { "type": "integer", "description": "For warehouse destinations, rows to buffer before flushing a batch (default 1000).", @@ -51606,22 +51768,22 @@ "properties": { "awsKeyId": { "type": "string", - "description": "The AWS access key ID for the Kinesis or S3 destination.", + "description": "The AWS access key ID for the `kinesis`, `s3`, and `sqs` destinations. Required for `sqs`.", "example": "AKIAIOSFODNN7EXAMPLE" }, "awsSecretKey": { "type": "string", - "description": "The AWS secret access key for the Kinesis or S3 destination.", + "description": "The AWS secret access key for the `kinesis`, `s3`, and `sqs` destinations. Required for `sqs`.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" }, "awsSessionToken": { "type": "string", - "description": "The AWS session token for the Kinesis or S3 destination.", + "description": "The optional AWS session token for the `kinesis`, `s3`, and `sqs` destinations.", "example": "AQoEXAMPLEH4aoAH0gNCAPy..." }, "password": { "type": "string", - "description": "The password for the `clickhouse` destination.", + "description": "The password for the `clickhouse`, `rabbitmq`, and `kafka` destinations. Required for `rabbitmq` and `kafka`.", "example": "my-clickhouse-password" }, "privateKey": { @@ -51631,17 +51793,17 @@ }, "credentials": { "type": "string", - "description": "The service-account credentials JSON for the `bigquery`, `gcs`, and `pubsub` destinations.", + "description": "The service-account credentials JSON for the `bigquery`, `gcs`, and `pubsub` destinations. Required for `pubsub`.", "example": "{\"type\":\"service_account\", ...}" }, "accessKeyId": { "type": "string", - "description": "The AWS access key ID for the `redshift`, `sqs`, `sns`, and `eventbridge` destinations.", + "description": "The AWS access key ID for the `redshift` and `eventbridge` destinations.", "example": "AKIAIOSFODNN7EXAMPLE" }, "secretAccessKey": { "type": "string", - "description": "The AWS secret access key for the `redshift`, `sqs`, `sns`, and `eventbridge` destinations.", + "description": "The AWS secret access key for the `redshift` and `eventbridge` destinations.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" }, "accessKey": { @@ -51649,10 +51811,15 @@ "description": "The account access key for the `azureblob` destination.", "example": "my-azure-access-key" }, - "uri": { + "username": { + "type": "string", + "description": "The username for the `rabbitmq` and `kafka` destinations. Required for both.", + "example": "ampersand" + }, + "connectionString": { "type": "string", - "description": "The connection URI (embeds credentials) for the `rabbitmq` destination.", - "example": "amqp://user:pass@rabbit.example.com:5672" + "description": "The connection string for the `azureservicebus` destination. Required for `azureservicebus`.", + "example": "Endpoint=sb://my-namespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=..." } } } @@ -51824,11 +51991,6 @@ "description": "The SQS queue URL for the sqs destination", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue" }, - "topicArn": { - "type": "string", - "description": "The SNS topic ARN for the sns destination", - "example": "arn:aws:sns:us-east-1:123456789012:my-topic" - }, "eventBusName": { "type": "string", "description": "The EventBridge event bus name for the eventbridge destination", @@ -51844,11 +52006,46 @@ "description": "The Pub/Sub topic ID for the pubsub destination", "example": "ampersand-events" }, - "routingKey": { + "serverUrl": { "type": "string", - "description": "The routing key for the rabbitmq destination", + "description": "The AMQP server URL for the rabbitmq destination", + "example": "amqp://rabbit.example.com:5672" + }, + "exchange": { + "type": "string", + "description": "The exchange to publish to for the rabbitmq destination", "example": "ampersand.events" }, + "tls": { + "type": "boolean", + "description": "Whether to connect over TLS (rabbitmq, kafka)", + "example": true + }, + "name": { + "type": "string", + "description": "The queue or topic name for the azureservicebus destination", + "example": "ampersand-events" + }, + "brokers": { + "type": "string", + "description": "The comma-separated list of Kafka broker addresses for the kafka destination", + "example": "broker1.example.com:9092,broker2.example.com:9092" + }, + "topic": { + "type": "string", + "description": "The Kafka topic to publish to for the kafka destination", + "example": "ampersand-events" + }, + "saslMechanism": { + "type": "string", + "description": "The SASL mechanism used to authenticate to Kafka for the kafka destination", + "enum": [ + "plain", + "scram-sha-256", + "scram-sha-512" + ], + "example": "scram-sha-256" + }, "batchSize": { "type": "integer", "description": "For warehouse destinations, rows to buffer before flushing a batch (default 1000)", @@ -69496,11 +69693,6 @@ "description": "The SQS queue URL for the sqs destination", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue" }, - "topicArn": { - "type": "string", - "description": "The SNS topic ARN for the sns destination", - "example": "arn:aws:sns:us-east-1:123456789012:my-topic" - }, "eventBusName": { "type": "string", "description": "The EventBridge event bus name for the eventbridge destination", @@ -69516,11 +69708,46 @@ "description": "The Pub/Sub topic ID for the pubsub destination", "example": "ampersand-events" }, - "routingKey": { + "serverUrl": { "type": "string", - "description": "The routing key for the rabbitmq destination", + "description": "The AMQP server URL for the rabbitmq destination", + "example": "amqp://rabbit.example.com:5672" + }, + "exchange": { + "type": "string", + "description": "The exchange to publish to for the rabbitmq destination", "example": "ampersand.events" }, + "tls": { + "type": "boolean", + "description": "Whether to connect over TLS (rabbitmq, kafka)", + "example": true + }, + "name": { + "type": "string", + "description": "The queue or topic name for the azureservicebus destination", + "example": "ampersand-events" + }, + "brokers": { + "type": "string", + "description": "The comma-separated list of Kafka broker addresses for the kafka destination", + "example": "broker1.example.com:9092,broker2.example.com:9092" + }, + "topic": { + "type": "string", + "description": "The Kafka topic to publish to for the kafka destination", + "example": "ampersand-events" + }, + "saslMechanism": { + "type": "string", + "description": "The SASL mechanism used to authenticate to Kafka for the kafka destination", + "enum": [ + "plain", + "scram-sha-256", + "scram-sha-512" + ], + "example": "scram-sha-256" + }, "batchSize": { "type": "integer", "description": "For warehouse destinations, rows to buffer before flushing a batch (default 1000)", @@ -69702,11 +69929,6 @@ "description": "The SQS queue URL for the sqs destination", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue" }, - "topicArn": { - "type": "string", - "description": "The SNS topic ARN for the sns destination", - "example": "arn:aws:sns:us-east-1:123456789012:my-topic" - }, "eventBusName": { "type": "string", "description": "The EventBridge event bus name for the eventbridge destination", @@ -69722,11 +69944,46 @@ "description": "The Pub/Sub topic ID for the pubsub destination", "example": "ampersand-events" }, - "routingKey": { + "serverUrl": { + "type": "string", + "description": "The AMQP server URL for the rabbitmq destination", + "example": "amqp://rabbit.example.com:5672" + }, + "exchange": { "type": "string", - "description": "The routing key for the rabbitmq destination", + "description": "The exchange to publish to for the rabbitmq destination", "example": "ampersand.events" }, + "tls": { + "type": "boolean", + "description": "Whether to connect over TLS (rabbitmq, kafka)", + "example": true + }, + "name": { + "type": "string", + "description": "The queue or topic name for the azureservicebus destination", + "example": "ampersand-events" + }, + "brokers": { + "type": "string", + "description": "The comma-separated list of Kafka broker addresses for the kafka destination", + "example": "broker1.example.com:9092,broker2.example.com:9092" + }, + "topic": { + "type": "string", + "description": "The Kafka topic to publish to for the kafka destination", + "example": "ampersand-events" + }, + "saslMechanism": { + "type": "string", + "description": "The SASL mechanism used to authenticate to Kafka for the kafka destination", + "enum": [ + "plain", + "scram-sha-256", + "scram-sha-512" + ], + "example": "scram-sha-256" + }, "batchSize": { "type": "integer", "description": "For warehouse destinations, rows to buffer before flushing a batch (default 1000)", From 9eec115f1b48d228ae720883c940d704a14024fb Mon Sep 17 00:00:00 2001 From: RajatPawar <18614743+RajatPawar@users.noreply.github.com> Date: Wed, 19 Aug 2026 14:59:25 -0700 Subject: [PATCH 2/2] =?UTF-8?q?feat(destinations):=20remove=20EventBridge?= =?UTF-8?q?=20from=20openapi=20=E2=80=94=20not=20currently=20supported=20(?= =?UTF-8?q?ENG-4130)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Claude Opus 4.8 --- api/api.yaml | 50 +++--------------- api/generated/api.bundled.json | 55 +++----------------- api/generated/api.json | 95 +++------------------------------- 3 files changed, 18 insertions(+), 182 deletions(-) diff --git a/api/api.yaml b/api/api.yaml index a33927e..76d62a2 100644 --- a/api/api.yaml +++ b/api/api.yaml @@ -3018,11 +3018,11 @@ paths: description: The type of the destination. For `slack`, set `metadata.url` to a Slack incoming webhook URL. The warehouse and message-queue types (`clickhouse`, - `snowflake`, `bigquery`, `redshift`, `sqs`, `eventbridge`, + `snowflake`, `bigquery`, `redshift`, `sqs`, `pubsub`, `rabbitmq`, `azureservicebus`, `kafka`) are configured via the `metadata` and `secrets` fields documented below. example: webhook - enum: [webhook, kinesis, s3, slack, clickhouse, snowflake, bigquery, redshift, sqs, eventbridge, pubsub, rabbitmq, azureservicebus, kafka] + enum: [webhook, kinesis, s3, slack, clickhouse, snowflake, bigquery, redshift, sqs, pubsub, rabbitmq, azureservicebus, kafka] secrets: type: object description: Secrets for the destination. @@ -3064,14 +3064,12 @@ paths: x-go-type-skip-optional-pointer: true accessKeyId: type: string - description: The AWS access key ID for the `redshift` and `eventbridge` - destinations. + description: The AWS access key ID for the `redshift` destination. example: AKIAIOSFODNN7EXAMPLE x-go-type-skip-optional-pointer: true secretAccessKey: type: string - description: The AWS secret access key for the `redshift` and `eventbridge` - destinations. + description: The AWS secret access key for the `redshift` destination. example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY x-go-type-skip-optional-pointer: true accessKey: @@ -3220,16 +3218,6 @@ paths: Required for `sqs`. example: https://sqs.us-east-1.amazonaws.com/123456789012/my-queue x-go-type-skip-optional-pointer: true - eventBusName: - type: string - description: The EventBridge event bus name for the `eventbridge` destination. - example: default - x-go-type-skip-optional-pointer: true - detailType: - type: string - description: The EventBridge detail-type for published events (`eventbridge`). - example: ampersand.record - x-go-type-skip-optional-pointer: true topicId: type: string description: The Pub/Sub topic ID for the `pubsub` destination. @@ -3459,8 +3447,6 @@ paths: - metadata.account - metadata.container - metadata.queueUrl - - metadata.eventBusName - - metadata.detailType - metadata.topicId - metadata.serverUrl - metadata.exchange @@ -3596,14 +3582,6 @@ paths: description: The SQS queue URL for the `sqs` destination. Required for `sqs`. example: https://sqs.us-east-1.amazonaws.com/123456789012/my-queue - eventBusName: - type: string - description: The EventBridge event bus name for the `eventbridge` destination. - example: default - detailType: - type: string - description: The EventBridge detail-type for published events (`eventbridge`). - example: ampersand.record topicId: type: string description: The Pub/Sub topic ID for the `pubsub` destination. @@ -3687,11 +3665,11 @@ paths: example: '{"type":"service_account", ...}' accessKeyId: type: string - description: The AWS access key ID for the `redshift` and `eventbridge` destinations. + description: The AWS access key ID for the `redshift` destination. example: AKIAIOSFODNN7EXAMPLE secretAccessKey: type: string - description: The AWS secret access key for the `redshift` and `eventbridge` destinations. + description: The AWS secret access key for the `redshift` destination. example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY accessKey: type: string @@ -5512,14 +5490,6 @@ components: type: string description: The SQS queue URL for the sqs destination example: https://sqs.us-east-1.amazonaws.com/123456789012/my-queue - eventBusName: - type: string - description: The EventBridge event bus name for the eventbridge destination - example: default - detailType: - type: string - description: The EventBridge detail-type for published events (eventbridge) - example: ampersand.record topicId: type: string description: The Pub/Sub topic ID for the pubsub destination @@ -5689,14 +5659,6 @@ components: type: string description: The SQS queue URL for the sqs destination example: https://sqs.us-east-1.amazonaws.com/123456789012/my-queue - eventBusName: - type: string - description: The EventBridge event bus name for the eventbridge destination - example: default - detailType: - type: string - description: The EventBridge detail-type for published events (eventbridge) - example: ampersand.record topicId: type: string description: The Pub/Sub topic ID for the pubsub destination diff --git a/api/generated/api.bundled.json b/api/generated/api.bundled.json index 1654059..c8514b0 100644 --- a/api/generated/api.bundled.json +++ b/api/generated/api.bundled.json @@ -4469,7 +4469,7 @@ }, "type": { "type": "string", - "description": "The type of the destination. For `slack`, set `metadata.url` to a Slack incoming webhook URL. The warehouse and message-queue types (`clickhouse`, `snowflake`, `bigquery`, `redshift`, `sqs`, `eventbridge`, `pubsub`, `rabbitmq`, `azureservicebus`, `kafka`) are configured via the `metadata` and `secrets` fields documented below.", + "description": "The type of the destination. For `slack`, set `metadata.url` to a Slack incoming webhook URL. The warehouse and message-queue types (`clickhouse`, `snowflake`, `bigquery`, `redshift`, `sqs`, `pubsub`, `rabbitmq`, `azureservicebus`, `kafka`) are configured via the `metadata` and `secrets` fields documented below.", "example": "webhook", "enum": [ "webhook", @@ -4481,7 +4481,6 @@ "bigquery", "redshift", "sqs", - "eventbridge", "pubsub", "rabbitmq", "azureservicebus", @@ -4530,13 +4529,13 @@ }, "accessKeyId": { "type": "string", - "description": "The AWS access key ID for the `redshift` and `eventbridge` destinations.", + "description": "The AWS access key ID for the `redshift` destination.", "example": "AKIAIOSFODNN7EXAMPLE", "x-go-type-skip-optional-pointer": true }, "secretAccessKey": { "type": "string", - "description": "The AWS secret access key for the `redshift` and `eventbridge` destinations.", + "description": "The AWS secret access key for the `redshift` destination.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "x-go-type-skip-optional-pointer": true }, @@ -4709,18 +4708,6 @@ "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue", "x-go-type-skip-optional-pointer": true }, - "eventBusName": { - "type": "string", - "description": "The EventBridge event bus name for the `eventbridge` destination.", - "example": "default", - "x-go-type-skip-optional-pointer": true - }, - "detailType": { - "type": "string", - "description": "The EventBridge detail-type for published events (`eventbridge`).", - "example": "ampersand.record", - "x-go-type-skip-optional-pointer": true - }, "topicId": { "type": "string", "description": "The Pub/Sub topic ID for the `pubsub` destination. Required for `pubsub`.", @@ -5007,7 +4994,7 @@ "items": { "type": "string" }, - "description": "Array of field paths specifying which fields to update. Allowed values include:\n- name\n- metadata.url\n- metadata.headers\n- metadata.region\n- metadata.streamName\n- metadata.endpointUrl\n- metadata.partitionKeyTemplate\n- metadata.bucket\n- metadata.keyTemplate\n- metadata.storageClass\n- metadata.username\n- metadata.tableName\n- metadata.database\n- metadata.accountIdentifier\n- metadata.userId\n- metadata.dbName\n- metadata.schemaName\n- metadata.projectId\n- metadata.datasetId\n- metadata.tableId\n- metadata.workgroupName\n- metadata.clusterIdentifier\n- metadata.dbUser\n- metadata.account\n- metadata.container\n- metadata.queueUrl\n- metadata.eventBusName\n- metadata.detailType\n- metadata.topicId\n- metadata.serverUrl\n- metadata.exchange\n- metadata.tls\n- metadata.name\n- metadata.brokers\n- metadata.topic\n- metadata.saslMechanism\n- metadata.batchSize\n- metadata.maxWaitSecs\n- secrets.awsKeyId\n- secrets.awsSecretKey\n- secrets.awsSessionToken\n- secrets.password\n- secrets.privateKey\n- secrets.credentials\n- secrets.accessKeyId\n- secrets.secretAccessKey\n- secrets.accessKey\n- secrets.username\n- secrets.connectionString\n", + "description": "Array of field paths specifying which fields to update. Allowed values include:\n- name\n- metadata.url\n- metadata.headers\n- metadata.region\n- metadata.streamName\n- metadata.endpointUrl\n- metadata.partitionKeyTemplate\n- metadata.bucket\n- metadata.keyTemplate\n- metadata.storageClass\n- metadata.username\n- metadata.tableName\n- metadata.database\n- metadata.accountIdentifier\n- metadata.userId\n- metadata.dbName\n- metadata.schemaName\n- metadata.projectId\n- metadata.datasetId\n- metadata.tableId\n- metadata.workgroupName\n- metadata.clusterIdentifier\n- metadata.dbUser\n- metadata.account\n- metadata.container\n- metadata.queueUrl\n- metadata.topicId\n- metadata.serverUrl\n- metadata.exchange\n- metadata.tls\n- metadata.name\n- metadata.brokers\n- metadata.topic\n- metadata.saslMechanism\n- metadata.batchSize\n- metadata.maxWaitSecs\n- secrets.awsKeyId\n- secrets.awsSecretKey\n- secrets.awsSessionToken\n- secrets.password\n- secrets.privateKey\n- secrets.credentials\n- secrets.accessKeyId\n- secrets.secretAccessKey\n- secrets.accessKey\n- secrets.username\n- secrets.connectionString\n", "example": [ "name", "metadata.url", @@ -5149,16 +5136,6 @@ "description": "The SQS queue URL for the `sqs` destination. Required for `sqs`.", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue" }, - "eventBusName": { - "type": "string", - "description": "The EventBridge event bus name for the `eventbridge` destination.", - "example": "default" - }, - "detailType": { - "type": "string", - "description": "The EventBridge detail-type for published events (`eventbridge`).", - "example": "ampersand.record" - }, "topicId": { "type": "string", "description": "The Pub/Sub topic ID for the `pubsub` destination. Required for `pubsub`.", @@ -5252,12 +5229,12 @@ }, "accessKeyId": { "type": "string", - "description": "The AWS access key ID for the `redshift` and `eventbridge` destinations.", + "description": "The AWS access key ID for the `redshift` destination.", "example": "AKIAIOSFODNN7EXAMPLE" }, "secretAccessKey": { "type": "string", - "description": "The AWS secret access key for the `redshift` and `eventbridge` destinations.", + "description": "The AWS secret access key for the `redshift` destination.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" }, "accessKey": { @@ -8065,16 +8042,6 @@ "description": "The SQS queue URL for the sqs destination", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue" }, - "eventBusName": { - "type": "string", - "description": "The EventBridge event bus name for the eventbridge destination", - "example": "default" - }, - "detailType": { - "type": "string", - "description": "The EventBridge detail-type for published events (eventbridge)", - "example": "ampersand.record" - }, "topicId": { "type": "string", "description": "The Pub/Sub topic ID for the pubsub destination", @@ -8291,16 +8258,6 @@ "description": "The SQS queue URL for the sqs destination", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue" }, - "eventBusName": { - "type": "string", - "description": "The EventBridge event bus name for the eventbridge destination", - "example": "default" - }, - "detailType": { - "type": "string", - "description": "The EventBridge detail-type for published events (eventbridge)", - "example": "ampersand.record" - }, "topicId": { "type": "string", "description": "The Pub/Sub topic ID for the pubsub destination", diff --git a/api/generated/api.json b/api/generated/api.json index df4cfe6..68dc12e 100644 --- a/api/generated/api.json +++ b/api/generated/api.json @@ -48971,7 +48971,7 @@ }, "type": { "type": "string", - "description": "The type of the destination. For `slack`, set `metadata.url` to a Slack incoming webhook URL. The warehouse and message-queue types (`clickhouse`, `snowflake`, `bigquery`, `redshift`, `sqs`, `eventbridge`, `pubsub`, `rabbitmq`, `azureservicebus`, `kafka`) are configured via the `metadata` and `secrets` fields documented below.", + "description": "The type of the destination. For `slack`, set `metadata.url` to a Slack incoming webhook URL. The warehouse and message-queue types (`clickhouse`, `snowflake`, `bigquery`, `redshift`, `sqs`, `pubsub`, `rabbitmq`, `azureservicebus`, `kafka`) are configured via the `metadata` and `secrets` fields documented below.", "example": "webhook", "enum": [ "webhook", @@ -48983,7 +48983,6 @@ "bigquery", "redshift", "sqs", - "eventbridge", "pubsub", "rabbitmq", "azureservicebus", @@ -49032,13 +49031,13 @@ }, "accessKeyId": { "type": "string", - "description": "The AWS access key ID for the `redshift` and `eventbridge` destinations.", + "description": "The AWS access key ID for the `redshift` destination.", "example": "AKIAIOSFODNN7EXAMPLE", "x-go-type-skip-optional-pointer": true }, "secretAccessKey": { "type": "string", - "description": "The AWS secret access key for the `redshift` and `eventbridge` destinations.", + "description": "The AWS secret access key for the `redshift` destination.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "x-go-type-skip-optional-pointer": true }, @@ -49221,18 +49220,6 @@ "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue", "x-go-type-skip-optional-pointer": true }, - "eventBusName": { - "type": "string", - "description": "The EventBridge event bus name for the `eventbridge` destination.", - "example": "default", - "x-go-type-skip-optional-pointer": true - }, - "detailType": { - "type": "string", - "description": "The EventBridge detail-type for published events (`eventbridge`).", - "example": "ampersand.record", - "x-go-type-skip-optional-pointer": true - }, "topicId": { "type": "string", "description": "The Pub/Sub topic ID for the `pubsub` destination. Required for `pubsub`.", @@ -49466,16 +49453,6 @@ "description": "The SQS queue URL for the sqs destination", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue" }, - "eventBusName": { - "type": "string", - "description": "The EventBridge event bus name for the eventbridge destination", - "example": "default" - }, - "detailType": { - "type": "string", - "description": "The EventBridge detail-type for published events (eventbridge)", - "example": "ampersand.record" - }, "topicId": { "type": "string", "description": "The Pub/Sub topic ID for the pubsub destination", @@ -50515,16 +50492,6 @@ "description": "The SQS queue URL for the sqs destination", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue" }, - "eventBusName": { - "type": "string", - "description": "The EventBridge event bus name for the eventbridge destination", - "example": "default" - }, - "detailType": { - "type": "string", - "description": "The EventBridge detail-type for published events (eventbridge)", - "example": "ampersand.record" - }, "topicId": { "type": "string", "description": "The Pub/Sub topic ID for the pubsub destination", @@ -50947,16 +50914,6 @@ "description": "The SQS queue URL for the sqs destination", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue" }, - "eventBusName": { - "type": "string", - "description": "The EventBridge event bus name for the eventbridge destination", - "example": "default" - }, - "detailType": { - "type": "string", - "description": "The EventBridge detail-type for published events (eventbridge)", - "example": "ampersand.record" - }, "topicId": { "type": "string", "description": "The Pub/Sub topic ID for the pubsub destination", @@ -51543,7 +51500,7 @@ "items": { "type": "string" }, - "description": "Array of field paths specifying which fields to update. Allowed values include:\n- name\n- metadata.url\n- metadata.headers\n- metadata.region\n- metadata.streamName\n- metadata.endpointUrl\n- metadata.partitionKeyTemplate\n- metadata.bucket\n- metadata.keyTemplate\n- metadata.storageClass\n- metadata.username\n- metadata.tableName\n- metadata.database\n- metadata.accountIdentifier\n- metadata.userId\n- metadata.dbName\n- metadata.schemaName\n- metadata.projectId\n- metadata.datasetId\n- metadata.tableId\n- metadata.workgroupName\n- metadata.clusterIdentifier\n- metadata.dbUser\n- metadata.account\n- metadata.container\n- metadata.queueUrl\n- metadata.eventBusName\n- metadata.detailType\n- metadata.topicId\n- metadata.serverUrl\n- metadata.exchange\n- metadata.tls\n- metadata.name\n- metadata.brokers\n- metadata.topic\n- metadata.saslMechanism\n- metadata.batchSize\n- metadata.maxWaitSecs\n- secrets.awsKeyId\n- secrets.awsSecretKey\n- secrets.awsSessionToken\n- secrets.password\n- secrets.privateKey\n- secrets.credentials\n- secrets.accessKeyId\n- secrets.secretAccessKey\n- secrets.accessKey\n- secrets.username\n- secrets.connectionString\n", + "description": "Array of field paths specifying which fields to update. Allowed values include:\n- name\n- metadata.url\n- metadata.headers\n- metadata.region\n- metadata.streamName\n- metadata.endpointUrl\n- metadata.partitionKeyTemplate\n- metadata.bucket\n- metadata.keyTemplate\n- metadata.storageClass\n- metadata.username\n- metadata.tableName\n- metadata.database\n- metadata.accountIdentifier\n- metadata.userId\n- metadata.dbName\n- metadata.schemaName\n- metadata.projectId\n- metadata.datasetId\n- metadata.tableId\n- metadata.workgroupName\n- metadata.clusterIdentifier\n- metadata.dbUser\n- metadata.account\n- metadata.container\n- metadata.queueUrl\n- metadata.topicId\n- metadata.serverUrl\n- metadata.exchange\n- metadata.tls\n- metadata.name\n- metadata.brokers\n- metadata.topic\n- metadata.saslMechanism\n- metadata.batchSize\n- metadata.maxWaitSecs\n- secrets.awsKeyId\n- secrets.awsSecretKey\n- secrets.awsSessionToken\n- secrets.password\n- secrets.privateKey\n- secrets.credentials\n- secrets.accessKeyId\n- secrets.secretAccessKey\n- secrets.accessKey\n- secrets.username\n- secrets.connectionString\n", "example": [ "name", "metadata.url", @@ -51695,16 +51652,6 @@ "description": "The SQS queue URL for the `sqs` destination. Required for `sqs`.", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue" }, - "eventBusName": { - "type": "string", - "description": "The EventBridge event bus name for the `eventbridge` destination.", - "example": "default" - }, - "detailType": { - "type": "string", - "description": "The EventBridge detail-type for published events (`eventbridge`).", - "example": "ampersand.record" - }, "topicId": { "type": "string", "description": "The Pub/Sub topic ID for the `pubsub` destination. Required for `pubsub`.", @@ -51798,12 +51745,12 @@ }, "accessKeyId": { "type": "string", - "description": "The AWS access key ID for the `redshift` and `eventbridge` destinations.", + "description": "The AWS access key ID for the `redshift` destination.", "example": "AKIAIOSFODNN7EXAMPLE" }, "secretAccessKey": { "type": "string", - "description": "The AWS secret access key for the `redshift` and `eventbridge` destinations.", + "description": "The AWS secret access key for the `redshift` destination.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" }, "accessKey": { @@ -51991,16 +51938,6 @@ "description": "The SQS queue URL for the sqs destination", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue" }, - "eventBusName": { - "type": "string", - "description": "The EventBridge event bus name for the eventbridge destination", - "example": "default" - }, - "detailType": { - "type": "string", - "description": "The EventBridge detail-type for published events (eventbridge)", - "example": "ampersand.record" - }, "topicId": { "type": "string", "description": "The Pub/Sub topic ID for the pubsub destination", @@ -69693,16 +69630,6 @@ "description": "The SQS queue URL for the sqs destination", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue" }, - "eventBusName": { - "type": "string", - "description": "The EventBridge event bus name for the eventbridge destination", - "example": "default" - }, - "detailType": { - "type": "string", - "description": "The EventBridge detail-type for published events (eventbridge)", - "example": "ampersand.record" - }, "topicId": { "type": "string", "description": "The Pub/Sub topic ID for the pubsub destination", @@ -69929,16 +69856,6 @@ "description": "The SQS queue URL for the sqs destination", "example": "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue" }, - "eventBusName": { - "type": "string", - "description": "The EventBridge event bus name for the eventbridge destination", - "example": "default" - }, - "detailType": { - "type": "string", - "description": "The EventBridge detail-type for published events (eventbridge)", - "example": "ampersand.record" - }, "topicId": { "type": "string", "description": "The Pub/Sub topic ID for the pubsub destination",