Skip to content

Commit

Permalink
fix: remove links from generated code
Browse files Browse the repository at this point in the history
  • Loading branch information
raulb committed Mar 11, 2024
1 parent 98491a8 commit 75c2e59
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 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](/docs/features/opencdc-record).
Unwraps a Debezium record from the input 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](/docs/features/opencdc-record)'s payload, and needs to be unwrapped for further usage.
In such cases, the Debezium record is set as the OpenCDC 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](/docs/features/opencdc-record).
Unwraps a Kafka Connect record from an OpenCDC record.

## Description

This processor unwraps a Kafka Connect record from the input [OpenCDC record](/docs/features/opencdc-record).
This processor unwraps a Kafka Connect record from the input 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](/docs/features/opencdc-record)'s payload, and needs to be unwrapped for further usage.
In such cases, the Debezium record is set as the 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](/docs/features/opencdc-record)'s payload.
The Kafka Connect record's payload will replace the 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
12 changes: 6 additions & 6 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](/docs/features/opencdc-record) saved in one of the record's fields.
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
systems before being written to a final destination. In these cases, the original [OpenCDC record](/docs/features/opencdc-record) is part of the payload
systems before being written to a final destination. In these cases, the original 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](/docs/features/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 record is not in a structured data field, then it's assumed that it's stored in JSON format.

## Configuration parameters

Expand All @@ -35,17 +35,17 @@ Note: if the wrapped [OpenCDC record](/docs/features/opencdc-record) is not in a
<td>string</td>
<td>`.Payload.After`</td>
<td>
Field is a reference to the field which contains the [OpenCDC record](/docs/features/opencdc-record)
Field is a reference to the field which contains the OpenCDC record
(see [`sdk.NewReferenceResolver`](https://github.com/ConduitIO/conduit-processor-sdk/blob/02b60dc7acad11a2fcdf0a0188a13cf573648650/util.go#L53-L66)).
</td>
</tr>
</table>

## Examples

### Unwrap an [OpenCDC record](/docs/features/opencdc-record)
### Unwrap an OpenCDC record

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

#### Configuration parameters

Expand Down

0 comments on commit 75c2e59

Please sign in to comment.