Skip to content

Commit 2a742ba

Browse files
authored
fix: processor links (#1928)
* fix links * forgot the actual source
1 parent 6f995d9 commit 2a742ba

File tree

14 files changed

+14
-14
lines changed

14 files changed

+14
-14
lines changed

Diff for: pkg/plugin/processor/builtin/impl/avro/decode.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ and decodes the payload. The schema is cached locally after it's first downloade
8787
8888
If the processor encounters structured data or the data can't be decoded it returns an error.
8989
90-
This processor is the counterpart to [` + "`avro.encode`" + `](/docs/processors/builtin/avro.encode).`,
90+
This processor is the counterpart to [` + "`avro.encode`" + `](/docs/using/processors/builtin/avro.encode).`,
9191
Version: "v0.1.0",
9292
Author: "Meroxa, Inc.",
9393
Parameters: decodeConfig{}.Parameters(),

Diff for: pkg/plugin/processor/builtin/impl/avro/encode.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ It provides two strategies for determining the schema:
108108
checks need to be disabled for this schema to prevent failures. If the schema subject does not exist before running
109109
this processor, it will automatically set the correct compatibility settings in the schema registry.
110110
111-
This processor is the counterpart to [` + "`avro.decode`" + `](/docs/processors/builtin/avro.decode).`,
111+
This processor is the counterpart to [` + "`avro.decode`" + `](/docs/using/processors/builtin/avro.decode).`,
112112
Version: "v0.1.0",
113113
Author: "Meroxa, Inc.",
114114
Parameters: encodeConfig{}.Parameters(),

Diff for: pkg/plugin/processor/builtin/impl/base64/decode_examples_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ func ExampleDecodeProcessor() {
3030
Description: `This example decodes the base64 encoded string stored in
3131
` + "`.Payload.After`" + `. Note that the result is a string, so if you want to
3232
further process the result (e.g. parse the string as JSON), you need to chain
33-
other processors (e.g. [` + "`json.decode`" + `](/docs/processors/builtin/json.decode)).`,
33+
other processors (e.g. [` + "`json.decode`" + `](/docs/using/processors/builtin/json.decode)).`,
3434
Config: config.Config{
3535
"field": ".Payload.After.foo",
3636
},

Diff for: pkg/plugin/processor/builtin/impl/field/convert.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ func (p *convertProcessor) Specification() (sdk.Specification, error) {
5959
The applicable types are string, int, float and bool. Converting can be done between any combination of types. Note that
6060
booleans will be converted to numeric values 1 (true) and 0 (false). Processor is only applicable to ` + "`.Key`" + `, ` + "`.Payload.Before`" + `
6161
and ` + "`.Payload.After`" + ` prefixes, and only applicable if said fields contain structured data.
62-
If the record contains raw JSON data, then use the processor [` + "`json.decode`" + `](/docs/processors/builtin/json.decode)
62+
If the record contains raw JSON data, then use the processor [` + "`json.decode`" + `](/docs/using/processors/builtin/json.decode)
6363
to parse it into structured data first.`,
6464
Version: "v0.1.0",
6565
Author: "Meroxa, Inc.",

Diff for: pkg/plugin/processor/builtin/impl/field/exclude.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ If a field is excluded that contains nested data, the whole tree will be removed
5454
It is not allowed to exclude ` + "`.Position`" + ` or ` + "`.Operation`" + ` fields.
5555
5656
Note that this processor only runs on structured data, if the record contains
57-
raw JSON data, then use the processor [` + "`json.decode`" + `](/docs/processors/builtin/json.decode)
57+
raw JSON data, then use the processor [` + "`json.decode`" + `](/docs/using/processors/builtin/json.decode)
5858
to parse it into structured data first.`,
5959
Version: "v0.1.0",
6060
Author: "Meroxa, Inc.",

Diff for: pkg/plugin/processor/builtin/impl/field/rename.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ allowed to rename top-level fields (` + "`.Operation`" + `, ` + "`.Position`" +
5959
` + "`.Key`" + `, ` + "`.Metadata`" + `, ` + "`.Payload.Before`" + `, ` + "`.Payload.After`" + `).
6060
6161
Note that this processor only runs on structured data, if the record contains raw
62-
JSON data, then use the processor [` + "`json.decode`" + `](/docs/processors/builtin/json.decode)
62+
JSON data, then use the processor [` + "`json.decode`" + `](/docs/using/processors/builtin/json.decode)
6363
to parse it into structured data first.`,
6464
Version: "v0.1.0",
6565
Author: "Meroxa, Inc.",

Diff for: pkg/plugin/processor/builtin/impl/field/set.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ The new value can be a Go template expression, the processor will evaluate the o
5959
If the provided ` + "`field`" + ` doesn't exist, the processor will create that field and assign its value.
6060
This processor can be used for multiple purposes, like extracting fields, hoisting data, inserting fields, copying fields, masking fields, etc.
6161
Note that this processor only runs on structured data, if the record contains raw JSON data, then use the processor
62-
[` + "`json.decode`" + `](/docs/processors/builtin/json.decode) to parse it into structured data first.`,
62+
[` + "`json.decode`" + `](/docs/using/processors/builtin/json.decode) to parse it into structured data first.`,
6363
Version: "v0.1.0",
6464
Author: "Meroxa, Inc.",
6565
Parameters: setConfig{}.Parameters(),

Diff for: pkg/plugin/processor/builtin/internal/exampleutil/specs/avro.decode.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"specification": {
33
"name": "avro.decode",
44
"summary": "Decodes a field's raw data in the Avro format.",
5-
"description": "The processor takes raw data (bytes or a string) in the specified field and decodes\nit from the [Avro format](https://avro.apache.org/) into structured data. It extracts the schema ID from the data,\ndownloads the associated schema from the [schema registry](https://docs.confluent.io/platform/current/schema-registry/index.html)\nand decodes the payload. The schema is cached locally after it's first downloaded.\n\nIf the processor encounters structured data or the data can't be decoded it returns an error.\n\nThis processor is the counterpart to [`avro.encode`](/docs/processors/builtin/avro.encode).",
5+
"description": "The processor takes raw data (bytes or a string) in the specified field and decodes\nit from the [Avro format](https://avro.apache.org/) into structured data. It extracts the schema ID from the data,\ndownloads the associated schema from the [schema registry](https://docs.confluent.io/platform/current/schema-registry/index.html)\nand decodes the payload. The schema is cached locally after it's first downloaded.\n\nIf the processor encounters structured data or the data can't be decoded it returns an error.\n\nThis processor is the counterpart to [`avro.encode`](/docs/using/processors/builtin/avro.encode).",
66
"version": "v0.1.0",
77
"author": "Meroxa, Inc.",
88
"parameters": {

Diff for: pkg/plugin/processor/builtin/internal/exampleutil/specs/avro.encode.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"specification": {
33
"name": "avro.encode",
44
"summary": "Encodes a record's field into the Avro format.",
5-
"description": "The processor takes a record's field and encodes it using a schema into the [Avro format](https://avro.apache.org/).\nIt provides two strategies for determining the schema:\n\n* **preRegistered** (recommended)\n This strategy downloads an existing schema from the schema registry and uses it to encode the record.\n This requires the schema to already be registered in the schema registry. The schema is downloaded\n only once and cached locally.\n* **autoRegister** (for development purposes)\n This strategy infers the schema by inspecting the structured data and registers it in the schema\n registry. If the record schema is known in advance it's recommended to use the preRegistered strategy\n and manually register the schema, as this strategy comes with limitations.\n\n The strategy uses reflection to traverse the structured data of each record and determine the type\n of each field. If a specific field is set to nil the processor won't have enough information to determine\n the type and will default to a nullable string. Because of this it is not guaranteed that two records\n with the same structure produce the same schema or even a backwards compatible schema. The processor\n registers each inferred schema in the schema registry with the same subject, therefore the schema compatibility\n checks need to be disabled for this schema to prevent failures. If the schema subject does not exist before running\n this processor, it will automatically set the correct compatibility settings in the schema registry.\n\nThis processor is the counterpart to [`avro.decode`](/docs/processors/builtin/avro.decode).",
5+
"description": "The processor takes a record's field and encodes it using a schema into the [Avro format](https://avro.apache.org/).\nIt provides two strategies for determining the schema:\n\n* **preRegistered** (recommended)\n This strategy downloads an existing schema from the schema registry and uses it to encode the record.\n This requires the schema to already be registered in the schema registry. The schema is downloaded\n only once and cached locally.\n* **autoRegister** (for development purposes)\n This strategy infers the schema by inspecting the structured data and registers it in the schema\n registry. If the record schema is known in advance it's recommended to use the preRegistered strategy\n and manually register the schema, as this strategy comes with limitations.\n\n The strategy uses reflection to traverse the structured data of each record and determine the type\n of each field. If a specific field is set to nil the processor won't have enough information to determine\n the type and will default to a nullable string. Because of this it is not guaranteed that two records\n with the same structure produce the same schema or even a backwards compatible schema. The processor\n registers each inferred schema in the schema registry with the same subject, therefore the schema compatibility\n checks need to be disabled for this schema to prevent failures. If the schema subject does not exist before running\n this processor, it will automatically set the correct compatibility settings in the schema registry.\n\nThis processor is the counterpart to [`avro.decode`](/docs/using/processors/builtin/avro.decode).",
66
"version": "v0.1.0",
77
"author": "Meroxa, Inc.",
88
"parameters": {

Diff for: pkg/plugin/processor/builtin/internal/exampleutil/specs/base64.decode.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
"examples": [
5151
{
5252
"summary": "Decode a base64 encoded string",
53-
"description": "This example decodes the base64 encoded string stored in\n`.Payload.After`. Note that the result is a string, so if you want to\nfurther process the result (e.g. parse the string as JSON), you need to chain\nother processors (e.g. [`json.decode`](/docs/processors/builtin/json.decode)).",
53+
"description": "This example decodes the base64 encoded string stored in\n`.Payload.After`. Note that the result is a string, so if you want to\nfurther process the result (e.g. parse the string as JSON), you need to chain\nother processors (e.g. [`json.decode`](/docs/using/processors/builtin/json.decode)).",
5454
"config": {
5555
"field": ".Payload.After.foo"
5656
},

Diff for: pkg/plugin/processor/builtin/internal/exampleutil/specs/field.convert.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"specification": {
33
"name": "field.convert",
44
"summary": "Convert the type of a field.",
5-
"description": "Convert takes the field of one type and converts it into another type (e.g. string to integer). \nThe applicable types are string, int, float and bool. Converting can be done between any combination of types. Note that\nbooleans will be converted to numeric values 1 (true) and 0 (false). Processor is only applicable to `.Key`, `.Payload.Before`\nand `.Payload.After` prefixes, and only applicable if said fields contain structured data.\nIf the record contains raw JSON data, then use the processor [`json.decode`](/docs/processors/builtin/json.decode)\nto parse it into structured data first.",
5+
"description": "Convert takes the field of one type and converts it into another type (e.g. string to integer). \nThe applicable types are string, int, float and bool. Converting can be done between any combination of types. Note that\nbooleans will be converted to numeric values 1 (true) and 0 (false). Processor is only applicable to `.Key`, `.Payload.Before`\nand `.Payload.After` prefixes, and only applicable if said fields contain structured data.\nIf the record contains raw JSON data, then use the processor [`json.decode`](/docs/using/processors/builtin/json.decode)\nto parse it into structured data first.",
66
"version": "v0.1.0",
77
"author": "Meroxa, Inc.",
88
"parameters": {

Diff for: pkg/plugin/processor/builtin/internal/exampleutil/specs/field.exclude.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"specification": {
33
"name": "field.exclude",
44
"summary": "Remove a subset of fields from the record.",
5-
"description": "Remove a subset of fields from the record, all the other fields are left untouched.\nIf a field is excluded that contains nested data, the whole tree will be removed.\nIt is not allowed to exclude `.Position` or `.Operation` fields.\n\nNote that this processor only runs on structured data, if the record contains\nraw JSON data, then use the processor [`json.decode`](/docs/processors/builtin/json.decode)\nto parse it into structured data first.",
5+
"description": "Remove a subset of fields from the record, all the other fields are left untouched.\nIf a field is excluded that contains nested data, the whole tree will be removed.\nIt is not allowed to exclude `.Position` or `.Operation` fields.\n\nNote that this processor only runs on structured data, if the record contains\nraw JSON data, then use the processor [`json.decode`](/docs/using/processors/builtin/json.decode)\nto parse it into structured data first.",
66
"version": "v0.1.0",
77
"author": "Meroxa, Inc.",
88
"parameters": {

Diff for: pkg/plugin/processor/builtin/internal/exampleutil/specs/field.rename.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"specification": {
33
"name": "field.rename",
44
"summary": "Rename a group of fields.",
5-
"description": "Rename a group of field names to new names. It is not\nallowed to rename top-level fields (`.Operation`, `.Position`, \n`.Key`, `.Metadata`, `.Payload.Before`, `.Payload.After`).\n\nNote that this processor only runs on structured data, if the record contains raw\nJSON data, then use the processor [`json.decode`](/docs/processors/builtin/json.decode)\nto parse it into structured data first.",
5+
"description": "Rename a group of field names to new names. It is not\nallowed to rename top-level fields (`.Operation`, `.Position`, \n`.Key`, `.Metadata`, `.Payload.Before`, `.Payload.After`).\n\nNote that this processor only runs on structured data, if the record contains raw\nJSON data, then use the processor [`json.decode`](/docs/using/processors/builtin/json.decode)\nto parse it into structured data first.",
66
"version": "v0.1.0",
77
"author": "Meroxa, Inc.",
88
"parameters": {

Diff for: pkg/plugin/processor/builtin/internal/exampleutil/specs/field.set.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"specification": {
33
"name": "field.set",
44
"summary": "Set the value of a certain field.",
5-
"description": "Set the value of a certain field to any value. It is not allowed to set the `.Position` field.\nThe new value can be a Go template expression, the processor will evaluate the output and assign the value to the target field.\nIf the provided `field` doesn't exist, the processor will create that field and assign its value.\nThis processor can be used for multiple purposes, like extracting fields, hoisting data, inserting fields, copying fields, masking fields, etc.\nNote that this processor only runs on structured data, if the record contains raw JSON data, then use the processor\n[`json.decode`](/docs/processors/builtin/json.decode) to parse it into structured data first.",
5+
"description": "Set the value of a certain field to any value. It is not allowed to set the `.Position` field.\nThe new value can be a Go template expression, the processor will evaluate the output and assign the value to the target field.\nIf the provided `field` doesn't exist, the processor will create that field and assign its value.\nThis processor can be used for multiple purposes, like extracting fields, hoisting data, inserting fields, copying fields, masking fields, etc.\nNote that this processor only runs on structured data, if the record contains raw JSON data, then use the processor\n[`json.decode`](/docs/using/processors/builtin/json.decode) to parse it into structured data first.",
66
"version": "v0.1.0",
77
"author": "Meroxa, Inc.",
88
"parameters": {

0 commit comments

Comments
 (0)