Skip to content

Commit

Permalink
chore: update processors
Browse files Browse the repository at this point in the history
  • Loading branch information
raulb committed Mar 11, 2024
1 parent 75c2e59 commit 1c89966
Show file tree
Hide file tree
Showing 8 changed files with 22 additions and 22 deletions.
4 changes: 2 additions & 2 deletions docs/processors/builtin/unwrap.debezium.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import Box from "@mui/system/Box";

# `unwrap.debezium`

Unwraps a Debezium record from the input OpenCDC record.
Unwraps a Debezium record from the input [OpenCDC](https://conduit.io/docs/features/opencdc-record).

## Description

Expand All @@ -21,7 +21,7 @@ completely, except for the position.
The Debezium record's metadata and the wrapping record's metadata is merged, with the Debezium metadata having precedence.

This is useful in cases where Conduit acts as an intermediary between a Debezium source and a Debezium destination.
In such cases, the Debezium record is set as the OpenCDC record's payload, and needs to be unwrapped for further usage.
In such cases, the Debezium record is set as the [OpenCDC](https://conduit.io/docs/features/opencdc-record) record's payload,and needs to be unwrapped for further usage.

## Configuration parameters

Expand Down
8 changes: 4 additions & 4 deletions docs/processors/builtin/unwrap.kafkaconnect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ import Box from "@mui/system/Box";

# `unwrap.kafkaconnect`

Unwraps a Kafka Connect record from an OpenCDC record.
Unwraps a Kafka Connect record from an [OpenCDC](https://conduit.io/docs/features/opencdc-record).

## Description

This processor unwraps a Kafka Connect record from the input OpenCDC record.
This processor unwraps a Kafka Connect record from the input [OpenCDC](https://conduit.io/docs/features/opencdc-record).

The input record's payload is replaced with the Kafka Connect record.

This is useful in cases where Conduit acts as an intermediary between a Debezium source and a Debezium destination.
In such cases, the Debezium record is set as the OpenCDC record's payload, and needs to be unwrapped for further usage.
In such cases, the Debezium record is set as the [OpenCDC](https://conduit.io/docs/features/opencdc-record)'s payload, and needs to be unwrapped for further usage.

## Configuration parameters

Expand Down Expand Up @@ -49,7 +49,7 @@ Field is a reference to the field which contains the Kafka Connect record
This example shows how to unwrap a Kafka Connect record.

The Kafka Connect record is serialized as a JSON string in the `.Payload.After` field (raw data).
The Kafka Connect record's payload will replace the OpenCDC record's payload.
The Kafka Connect record's payload will replace the [OpenCDC](https://conduit.io/docs/features/opencdc-record)'s payload.

We also see how the key is unwrapped too. In this case, the key comes in as structured data.

Expand Down
10 changes: 5 additions & 5 deletions docs/processors/builtin/unwrap.opencdc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ import Box from "@mui/system/Box";

# `unwrap.opencdc`

Unwraps an OpenCDC record saved in one of the record's fields.
Unwraps an [OpenCDC](https://conduit.io/docs/features/opencdc-record) saved in one of the record's fields.

## Description

The `unwrap.opencdc` processor is useful in situations where a record goes through intermediate
systems before being written to a final destination. In these cases, the original OpenCDC record is part of the payload
systems before being written to a final destination. In these cases, the original [OpenCDC](https://conduit.io/docs/features/opencdc-record) is part of the payload
read from the intermediate system and needs to be unwrapped before being written.

Note: if the wrapped OpenCDC record is not in a structured data field, then it's assumed that it's stored in JSON format.
Note: if the wrapped [OpenCDC](https://conduit.io/docs/features/opencdc-record) is not in a structured data field, then it's assumed that it's stored in JSON format.

## Configuration parameters

Expand All @@ -43,9 +43,9 @@ Field is a reference to the field which contains the OpenCDC record

## Examples

### Unwrap an OpenCDC record
### Unwrap an [OpenCDC](https://conduit.io/docs/features/opencdc-record)

In this example we use the `unwrap.opencdc` processor to unwrap the OpenCDC record found in the record's `.Payload.After` field.
In this example we use the `unwrap.opencdc` processor to unwrap the [OpenCDC](https://conduit.io/docs/features/opencdc-record) found in the record's `.Payload.After` field.

#### Configuration parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/processors/builtin/webhook.http.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import Box from "@mui/system/Box";

# `webhook.http`

Trigger a HTTP request for every record.
Trigger an HTTP request for every record.

## Description

Expand Down
4 changes: 2 additions & 2 deletions src/processorgen/specs/unwrap.debezium.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"specification": {
"name": "unwrap.debezium",
"summary": "Unwraps a Debezium record from the input OpenCDC record.",
"description": "In this processor, the wrapped (Debezium) record replaces the wrapping record (being processed) \ncompletely, except for the position.\n\nThe Debezium record's metadata and the wrapping record's metadata is merged, with the Debezium metadata having precedence.\n\nThis is useful in cases where Conduit acts as an intermediary between a Debezium source and a Debezium destination. \nIn such cases, the Debezium record is set as the OpenCDC record's payload, and needs to be unwrapped for further usage.",
"summary": "Unwraps a Debezium record from the input [OpenCDC](https://conduit.io/docs/features/opencdc-record).",
"description": "In this processor, the wrapped (Debezium) record replaces the wrapping record (being processed) \ncompletely, except for the position.\n\nThe Debezium record's metadata and the wrapping record's metadata is merged, with the Debezium metadata having precedence.\n\nThis is useful in cases where Conduit acts as an intermediary between a Debezium source and a Debezium destination. \nIn such cases, the Debezium record is set as the [OpenCDC](https://conduit.io/docs/features/opencdc-record) record's payload,and needs to be unwrapped for further usage.",
"version": "v0.1.0",
"author": "Meroxa, Inc.",
"parameters": {
Expand Down
6 changes: 3 additions & 3 deletions src/processorgen/specs/unwrap.kafkaconnect.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"specification": {
"name": "unwrap.kafkaconnect",
"summary": "Unwraps a Kafka Connect record from an OpenCDC record.",
"description": "This processor unwraps a Kafka Connect record from the input OpenCDC record.\n\nThe input record's payload is replaced with the Kafka Connect record.\n\nThis is useful in cases where Conduit acts as an intermediary between a Debezium source and a Debezium destination. \nIn such cases, the Debezium record is set as the OpenCDC record's payload, and needs to be unwrapped for further usage.",
"summary": "Unwraps a Kafka Connect record from an [OpenCDC](https://conduit.io/docs/features/opencdc-record).",
"description": "This processor unwraps a Kafka Connect record from the input [OpenCDC](https://conduit.io/docs/features/opencdc-record).\n\nThe input record's payload is replaced with the Kafka Connect record.\n\nThis is useful in cases where Conduit acts as an intermediary between a Debezium source and a Debezium destination. \nIn such cases, the Debezium record is set as the [OpenCDC](https://conduit.io/docs/features/opencdc-record)'s payload, and needs to be unwrapped for further usage.",
"version": "v0.1.0",
"author": "Meroxa, Inc.",
"parameters": {
Expand All @@ -22,7 +22,7 @@
"examples": [
{
"summary": "Unwrap a Kafka Connect record",
"description": "This example shows how to unwrap a Kafka Connect record.\n\nThe Kafka Connect record is serialized as a JSON string in the `.Payload.After` field (raw data).\nThe Kafka Connect record's payload will replace the OpenCDC record's payload.\n\nWe also see how the key is unwrapped too. In this case, the key comes in as structured data.",
"description": "This example shows how to unwrap a Kafka Connect record.\n\nThe Kafka Connect record is serialized as a JSON string in the `.Payload.After` field (raw data).\nThe Kafka Connect record's payload will replace the [OpenCDC](https://conduit.io/docs/features/opencdc-record)'s payload.\n\nWe also see how the key is unwrapped too. In this case, the key comes in as structured data.",
"config": {
"field": ".Payload.After"
},
Expand Down
8 changes: 4 additions & 4 deletions src/processorgen/specs/unwrap.opencdc.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"specification": {
"name": "unwrap.opencdc",
"summary": "Unwraps an OpenCDC record saved in one of the record's fields.",
"description": "The `unwrap.opencdc` processor is useful in situations where a record goes through intermediate\nsystems before being written to a final destination. In these cases, the original OpenCDC record is part of the payload\nread from the intermediate system and needs to be unwrapped before being written.\n\nNote: if the wrapped OpenCDC record is not in a structured data field, then it's assumed that it's stored in JSON format.",
"summary": "Unwraps an [OpenCDC](https://conduit.io/docs/features/opencdc-record) saved in one of the record's fields.",
"description": "The `unwrap.opencdc` processor is useful in situations where a record goes through intermediate\nsystems before being written to a final destination. In these cases, the original [OpenCDC](https://conduit.io/docs/features/opencdc-record) is part of the payload\nread from the intermediate system and needs to be unwrapped before being written.\n\nNote: if the wrapped [OpenCDC](https://conduit.io/docs/features/opencdc-record) is not in a structured data field, then it's assumed that it's stored in JSON format.",
"version": "v0.1.0",
"author": "Meroxa, Inc.",
"parameters": {
Expand All @@ -16,8 +16,8 @@
},
"examples": [
{
"summary": "Unwrap an OpenCDC record",
"description": "In this example we use the `unwrap.opencdc` processor to unwrap the OpenCDC record found in the record's `.Payload.After` field.",
"summary": "Unwrap an [OpenCDC](https://conduit.io/docs/features/opencdc-record)",
"description": "In this example we use the `unwrap.opencdc` processor to unwrap the [OpenCDC](https://conduit.io/docs/features/opencdc-record) found in the record's `.Payload.After` field.",
"config": {
"field": ".Payload.After"
},
Expand Down
2 changes: 1 addition & 1 deletion src/processorgen/specs/webhook.http.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"specification": {
"name": "webhook.http",
"summary": "Trigger a HTTP request for every record.",
"summary": "Trigger an HTTP request for every record.",
"description": "A processor that sends an HTTP request to the specified URL, retries on error and \nsaves the response body and, optionally, the response status.",
"version": "v0.1.0",
"author": "Meroxa, Inc.",
Expand Down

0 comments on commit 1c89966

Please sign in to comment.