Skip to content

Commit

Permalink
fix: processor links (#1928)
Browse files Browse the repository at this point in the history
* fix links

* forgot the actual source
  • Loading branch information
raulb authored Oct 24, 2024
1 parent 6f995d9 commit 2a742ba
Show file tree
Hide file tree
Showing 14 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion pkg/plugin/processor/builtin/impl/avro/decode.go
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ and decodes the payload. The schema is cached locally after it's first downloade
If the processor encounters structured data or the data can't be decoded it returns an error.
This processor is the counterpart to [` + "`avro.encode`" + `](/docs/processors/builtin/avro.encode).`,
This processor is the counterpart to [` + "`avro.encode`" + `](/docs/using/processors/builtin/avro.encode).`,
Version: "v0.1.0",
Author: "Meroxa, Inc.",
Parameters: decodeConfig{}.Parameters(),
Expand Down
2 changes: 1 addition & 1 deletion pkg/plugin/processor/builtin/impl/avro/encode.go
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ It provides two strategies for determining the schema:
checks need to be disabled for this schema to prevent failures. If the schema subject does not exist before running
this processor, it will automatically set the correct compatibility settings in the schema registry.
This processor is the counterpart to [` + "`avro.decode`" + `](/docs/processors/builtin/avro.decode).`,
This processor is the counterpart to [` + "`avro.decode`" + `](/docs/using/processors/builtin/avro.decode).`,
Version: "v0.1.0",
Author: "Meroxa, Inc.",
Parameters: encodeConfig{}.Parameters(),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ func ExampleDecodeProcessor() {
Description: `This example decodes the base64 encoded string stored in
` + "`.Payload.After`" + `. Note that the result is a string, so if you want to
further process the result (e.g. parse the string as JSON), you need to chain
other processors (e.g. [` + "`json.decode`" + `](/docs/processors/builtin/json.decode)).`,
other processors (e.g. [` + "`json.decode`" + `](/docs/using/processors/builtin/json.decode)).`,
Config: config.Config{
"field": ".Payload.After.foo",
},
Expand Down
2 changes: 1 addition & 1 deletion pkg/plugin/processor/builtin/impl/field/convert.go
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ func (p *convertProcessor) Specification() (sdk.Specification, error) {
The applicable types are string, int, float and bool. Converting can be done between any combination of types. Note that
booleans will be converted to numeric values 1 (true) and 0 (false). Processor is only applicable to ` + "`.Key`" + `, ` + "`.Payload.Before`" + `
and ` + "`.Payload.After`" + ` prefixes, and only applicable if said fields contain structured data.
If the record contains raw JSON data, then use the processor [` + "`json.decode`" + `](/docs/processors/builtin/json.decode)
If the record contains raw JSON data, then use the processor [` + "`json.decode`" + `](/docs/using/processors/builtin/json.decode)
to parse it into structured data first.`,
Version: "v0.1.0",
Author: "Meroxa, Inc.",
Expand Down
2 changes: 1 addition & 1 deletion pkg/plugin/processor/builtin/impl/field/exclude.go
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ If a field is excluded that contains nested data, the whole tree will be removed
It is not allowed to exclude ` + "`.Position`" + ` or ` + "`.Operation`" + ` fields.
Note that this processor only runs on structured data, if the record contains
raw JSON data, then use the processor [` + "`json.decode`" + `](/docs/processors/builtin/json.decode)
raw JSON data, then use the processor [` + "`json.decode`" + `](/docs/using/processors/builtin/json.decode)
to parse it into structured data first.`,
Version: "v0.1.0",
Author: "Meroxa, Inc.",
Expand Down
2 changes: 1 addition & 1 deletion pkg/plugin/processor/builtin/impl/field/rename.go
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ allowed to rename top-level fields (` + "`.Operation`" + `, ` + "`.Position`" +
` + "`.Key`" + `, ` + "`.Metadata`" + `, ` + "`.Payload.Before`" + `, ` + "`.Payload.After`" + `).
Note that this processor only runs on structured data, if the record contains raw
JSON data, then use the processor [` + "`json.decode`" + `](/docs/processors/builtin/json.decode)
JSON data, then use the processor [` + "`json.decode`" + `](/docs/using/processors/builtin/json.decode)
to parse it into structured data first.`,
Version: "v0.1.0",
Author: "Meroxa, Inc.",
Expand Down
2 changes: 1 addition & 1 deletion pkg/plugin/processor/builtin/impl/field/set.go
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ The new value can be a Go template expression, the processor will evaluate the o
If the provided ` + "`field`" + ` doesn't exist, the processor will create that field and assign its value.
This processor can be used for multiple purposes, like extracting fields, hoisting data, inserting fields, copying fields, masking fields, etc.
Note that this processor only runs on structured data, if the record contains raw JSON data, then use the processor
[` + "`json.decode`" + `](/docs/processors/builtin/json.decode) to parse it into structured data first.`,
[` + "`json.decode`" + `](/docs/using/processors/builtin/json.decode) to parse it into structured data first.`,
Version: "v0.1.0",
Author: "Meroxa, Inc.",
Parameters: setConfig{}.Parameters(),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"specification": {
"name": "avro.decode",
"summary": "Decodes a field's raw data in the Avro format.",
"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).",
"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).",
"version": "v0.1.0",
"author": "Meroxa, Inc.",
"parameters": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"specification": {
"name": "avro.encode",
"summary": "Encodes a record's field into the Avro format.",
"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).",
"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).",
"version": "v0.1.0",
"author": "Meroxa, Inc.",
"parameters": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"examples": [
{
"summary": "Decode a base64 encoded string",
"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)).",
"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)).",
"config": {
"field": ".Payload.After.foo"
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"specification": {
"name": "field.convert",
"summary": "Convert the type of a field.",
"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.",
"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.",
"version": "v0.1.0",
"author": "Meroxa, Inc.",
"parameters": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"specification": {
"name": "field.exclude",
"summary": "Remove a subset of fields from the record.",
"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.",
"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.",
"version": "v0.1.0",
"author": "Meroxa, Inc.",
"parameters": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"specification": {
"name": "field.rename",
"summary": "Rename a group of fields.",
"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.",
"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.",
"version": "v0.1.0",
"author": "Meroxa, Inc.",
"parameters": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"specification": {
"name": "field.set",
"summary": "Set the value of a certain field.",
"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.",
"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.",
"version": "v0.1.0",
"author": "Meroxa, Inc.",
"parameters": {
Expand Down

0 comments on commit 2a742ba

Please sign in to comment.