Update links about referencing fields in processors (#1424)

* Update links about referecing fields in processors

* update link to referencing fields in all processors

* rename processor example test files, update base64.decode doc

---------

Co-authored-by: Lovro Mažgon <[email protected]>

pkg/plugin/processor/builtin/impl/avro/decode.go

@@ -34,7 +34,9 @@ type decoder interface {
 }
 
 type decodeConfig struct {
-	// The field that will be encoded.
+	// The field that will be decoded.
+	//
+	// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
 	Field string `json:"field" default:".Payload.After"`
 
 	// URL of the schema registry (e.g. http://localhost:8085)

pkg/plugin/processor/builtin/impl/avro/encode.go

@@ -36,6 +36,8 @@ type encoder interface {
 
 type encodeConfig struct {
 	// The field that will be encoded.
+	//
+	// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
 	Field string `json:"field" default:".Payload.After"`
 
 	// URL of the schema registry (e.g. http://localhost:8085)

pkg/plugin/processor/builtin/impl/avro/examples_test.go → pkg/plugin/processor/builtin/impl/avro/z_examples_test.go

@@ -12,6 +12,9 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// This file is here only to contain the go:generate statement. It's named with
+// a "z_" prefix to ensure it's processed last by go generate.
+
 //go:generate go test -count=1 -tags export_processors .
 
 package avro

pkg/plugin/processor/builtin/impl/base64/decode.go

@@ -34,8 +34,10 @@ type decodeProcessor struct {
 }
 
 type decodeConfig struct {
-	// Field is the target field, as it would be addressed in a Go template (e.g. `.Payload.After.foo`).
-	// Note that it is not allowed to base64 decode the `.Position` field.
+	// Field is the reference to the target field. Note that it is not allowed to
+	// base64 decode the `.Position` field.
+	//
+	// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
 	Field string `json:"field" validate:"required,exclusion=.Position"`
 }
 

pkg/plugin/processor/builtin/impl/base64/encode.go

@@ -35,8 +35,10 @@ type encodeProcessor struct {
 }
 
 type encodeConfig struct {
-	// Field is the target field, as it would be addressed in a Go template (e.g. `.Payload.After.foo`).
-	// Note that it is not allowed to base64 encode the `.Position` field.
+	// Field is a reference to the target field. Note that it is not allowed to
+	// base64 encode the `.Position` field.
+	//
+	// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
 	Field string `json:"field" validate:"required,exclusion=.Position"`
 }
 

pkg/plugin/processor/builtin/impl/base64/examples_test.go → pkg/plugin/processor/builtin/impl/base64/z_examples_test.go

@@ -12,6 +12,9 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// This file is here only to contain the go:generate statement. It's named with
+// a "z_" prefix to ensure it's processed last by go generate.
+
 //go:generate go test -count=1 -tags export_processors .
 
 package base64

pkg/plugin/processor/builtin/impl/custom/examples_test.go → pkg/plugin/processor/builtin/impl/custom/z_examples_test.go

@@ -12,6 +12,9 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// This file is here only to contain the go:generate statement. It's named with
+// a "z_" prefix to ensure it's processed last by go generate.
+
 //go:generate go test -count=1 -tags export_processors .
 
 package custom

pkg/plugin/processor/builtin/impl/field/convert.go

@@ -39,8 +39,11 @@ func NewConvertProcessor(log.CtxLogger) sdk.Processor {
 }
 
 type convertConfig struct {
-	// Field is the target field, as it would be addressed in a Go template (e.g. `.Payload.After.foo`).
-	// you can only convert fields that are under `.Key` and `.Payload`, and said fields should contain structured data.
+	// Field is the target field that should be converted.
+	// Note that you can only convert fields in structured data under `.Key` and
+	// `.Payload`.
+	//
+	// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
 	Field string `json:"field" validate:"required,regex=^\\.(Payload|Key).*"`
 	// Type is the target field type after conversion, available options are: string, int, float, bool.
 	Type string `json:"type" validate:"required,inclusion=string|int|float|bool"`

pkg/plugin/processor/builtin/impl/field/exclude.go

@@ -38,7 +38,9 @@ func NewExcludeProcessor(log.CtxLogger) sdk.Processor {
 }
 
 type excludeConfig struct {
-	// Fields is a comma separated list of target fields, as they would be addressed in a Go template (e.g. `.Metadata,.Payload.After.foo`).
+	// Fields is a comma separated list of target fields which should be excluded.
+	//
+	// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
 	Fields []string `json:"fields" validate:"required"`
 }
 

pkg/plugin/processor/builtin/impl/field/rename.go

@@ -40,8 +40,12 @@ func NewRenameProcessor(log.CtxLogger) sdk.Processor {
 }
 
 type renameConfig struct {
-	// Mapping is a comma separated list of keys and values for fields and their new names (keys and values
-	// are separated by colons ":"). For example: `.Metadata.key:id,.Payload.After.foo:bar`.
+	// Mapping is a comma separated list of keys and values for fields and their
+	// new names (keys and values are separated by colons ":").
+	//
+	// For example: `.Metadata.key:id,.Payload.After.foo:bar`.
+	//
+	// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
 	Mapping []string `json:"mapping" validate:"required"`
 }
 

pkg/plugin/processor/builtin/impl/field/set.go

@@ -40,8 +40,10 @@ func NewSetProcessor(log.CtxLogger) sdk.Processor {
 }
 
 type setConfig struct {
-	// Field is the target field, as it would be addressed in a Go template (e.g. `.Payload.After.foo`).
-	// Note that it is not allowed to set the `.Position` field.
+	// Field is the target field that will be set. Note that it is not allowed
+	// to set the `.Position` field.
+	//
+	// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
 	Field string `json:"field" validate:"required,exclusion=.Position"`
 	// Value is a Go template expression which will be evaluated and stored in `field` (e.g. `{{ .Payload.After }}`).
 	Value string `json:"value" validate:"required"`

pkg/plugin/processor/builtin/impl/field/examples_test.go → pkg/plugin/processor/builtin/impl/field/z_examples_test.go

@@ -12,6 +12,9 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// This file is here only to contain the go:generate statement. It's named with
+// a "z_" prefix to ensure it's processed last by go generate.
+
 //go:generate go test -count=1 -tags export_processors .
 
 package field

pkg/plugin/processor/builtin/impl/filter.go

@@ -35,10 +35,12 @@ func (p *filterProcessor) Specification() (sdk.Specification, error) {
 	return sdk.Specification{
 		Name:    "filter",
 		Summary: "Acknowledges all records that get passed to the filter.",
-		Description: `Acknowledges all records that get passed to the filter, so the records will be filtered out if 
-the condition provided to the processor is evaluated to "true".
+		Description: `Acknowledges all records that get passed to the filter, so
+the records will be filtered out if the condition provided to the processor is
+evaluated to ` + "`true`" + `.
 
-**Important:** Make sure to add a condition to this processor, otherwise all records will be filtered out.`,
+**Important:** Make sure to add a [condition](https://conduit.io/docs/processors/conditions)
+to this processor, otherwise all records will be filtered out.`,
 		Version:    "v0.1.0",
 		Author:     "Meroxa, Inc.",
 		Parameters: map[string]config.Parameter{},

pkg/plugin/processor/builtin/impl/json/decode.go

@@ -37,8 +37,10 @@ func NewDecodeProcessor(log.CtxLogger) sdk.Processor {
 }
 
 type decodeConfig struct {
-	// Field is the target field, as it would be addressed in a Go template (e.g. `.Payload.After.foo`).
-	// you can only decode fields that are under `.Key` and `.Payload`.
+	// Field is a reference to the target field. Only fields that are under
+	// `.Key` and `.Payload` can be decoded.
+	//
+	// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
 	Field string `json:"field" validate:"required,regex=^\\.(Payload|Key).*,exclusion=.Payload"`
 }
 

pkg/plugin/processor/builtin/impl/json/encode.go

@@ -37,8 +37,10 @@ func NewEncodeProcessor(log.CtxLogger) sdk.Processor {
 }
 
 type encodeConfig struct {
-	// Field is the target field, as it would be addressed in a Go template (e.g. `.Payload.After.foo`).
-	// you can only encode fields that are under `.Key`, `.Payload.Before` and `.Payload.After`.
+	// Field is a reference to the target field. Only fields that are under
+	// `.Key` and `.Payload` can be encoded.
+	//
+	// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
 	Field string `json:"field" validate:"required,regex=^\\.(Payload|Key).*,exclusion=.Payload"`
 }
 

pkg/plugin/processor/builtin/impl/json/examples_test.go → pkg/plugin/processor/builtin/impl/json/z_examples_test.go

@@ -12,6 +12,9 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// This file is here only to contain the go:generate statement. It's named with
+// a "z_" prefix to ensure it's processed last by go generate.
+
 //go:generate go test -count=1 -tags export_processors .
 
 package json

pkg/plugin/processor/builtin/impl/unwrap/debezium.go

@@ -45,8 +45,9 @@ const (
 )
 
 type debeziumConfig struct {
-	// Field is a reference to the field which contains the Debezium record
-	// (see [`sdk.NewReferenceResolver`](https://github.com/ConduitIO/conduit-processor-sdk/blob/02b60dc7acad11a2fcdf0a0188a13cf573648650/util.go#L53-L66)).
+	// Field is a reference to the field that contains the Debezium record.
+	//
+	// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
 	Field string `json:"field" validate:"regex=^.Payload" default:".Payload.After"`
 }
 

pkg/plugin/processor/builtin/impl/unwrap/kafka_connect.go

@@ -28,8 +28,9 @@ import (
 )
 
 type kafkaConnectConfig struct {
-	// Field is a reference to the field which contains the Kafka Connect record
-	// (see [`sdk.NewReferenceResolver`](https://github.com/ConduitIO/conduit-processor-sdk/blob/02b60dc7acad11a2fcdf0a0188a13cf573648650/util.go#L53-L66)).
+	// Field is a reference to the field that contains the Kafka Connect record.
+	//
+	// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
 	Field string `json:"field" validate:"regex=^.Payload" default:".Payload.After"`
 }
 

pkg/plugin/processor/builtin/impl/unwrap/opencdc.go

@@ -29,8 +29,9 @@ import (
 )
 
 type openCDCConfig struct {
-	// 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)).
+	// Field is a reference to the field that contains the OpenCDC record.
+	//
+	// For more information about the format, see [Referencing fields](https://conduit.io/docs/processors/referencing-fields).
 	Field string `json:"field" default:".Payload.After"`
 }
 

pkg/plugin/processor/builtin/impl/unwrap/examples_test.go → pkg/plugin/processor/builtin/impl/unwrap/z_examples_test.go

@@ -12,6 +12,9 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// This file is here only to contain the go:generate statement. It's named with
+// a "z_" prefix to ensure it's processed last by go generate.
+
 //go:generate go test -count=1 -tags export_processors .
 
 package unwrap