From 39f25e10f7aa37ae6fe4cafe58773472f8ed0c04 Mon Sep 17 00:00:00 2001 From: Cynthia Peter Date: Thu, 14 Mar 2024 11:31:55 +0100 Subject: [PATCH 1/5] Update pages/docs/tutorials/kafka/bindings-with-kafka.md Co-authored-by: Lukasz Gornicki --- pages/docs/tutorials/kafka/bindings-with-kafka.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/tutorials/kafka/bindings-with-kafka.md b/pages/docs/tutorials/kafka/bindings-with-kafka.md index cbe12595218..9d235b3b2ca 100644 --- a/pages/docs/tutorials/kafka/bindings-with-kafka.md +++ b/pages/docs/tutorials/kafka/bindings-with-kafka.md @@ -58,7 +58,7 @@ Server bindings provide protocol-specific configuration details for connecting a Server bindings allows you to specify a `schemaRegistryUrl` which provides an API Url for a given server where a schema registry was used. A Schema registry is a repository for managing and validating messages' schemas. To learn more about schema registry read [this guide on message validation](https://www.asyncapi.com/docs/guides/message-validation#schema-registry-validation). -`schemaRegistryVendor` is used optionally to refer to vendors or platforms that provide the schema registry service, in this case "Apicurio". +`schemaRegistryVendor` is used optionally to refer to vendors or platforms that provide the schema registry service, in this case Apicurio Registry. ```yaml servers: From 37bba1de61daed6acbea2d24c6d778897671fffd Mon Sep 17 00:00:00 2001 From: Cynthia Peter Date: Thu, 14 Mar 2024 11:34:22 +0100 Subject: [PATCH 2/5] Update pages/docs/tutorials/kafka/bindings-with-kafka.md Co-authored-by: Lukasz Gornicki --- pages/docs/tutorials/kafka/bindings-with-kafka.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/tutorials/kafka/bindings-with-kafka.md b/pages/docs/tutorials/kafka/bindings-with-kafka.md index 9d235b3b2ca..43d84d02504 100644 --- a/pages/docs/tutorials/kafka/bindings-with-kafka.md +++ b/pages/docs/tutorials/kafka/bindings-with-kafka.md @@ -75,7 +75,7 @@ servers: [Learn more about server specific bindings.](https://github.com/asyncapi/bindings/tree/master/kafka#server-binding-object). -> Important: `BindingVersion` is the field version of a binding. It specifies the version of the binding specification that is used to describe how an API interacts with Kafka. The `bindingVersion` field is an optional field that is available for all bindings and ensures that as the specifications for different messaging systems evolve, APIs based on these specifications can remain consistent, compatible, and maintainable over time. +> Important: `bindingVersion` is the field version of a binding. It specifies the version of the binding specification that is used to describe how an API interacts with Kafka. The `bindingVersion` field is an optional field that is available for all bindings and ensures that as the specifications for different messaging systems evolve, APIs based on these specifications can remain consistent, compatible, and maintainable over time. ## Add operation bindings From 3b2c3521df43e07310e1e36d18e84e2cd321cf60 Mon Sep 17 00:00:00 2001 From: Cynthia Peter Date: Thu, 14 Mar 2024 11:35:57 +0100 Subject: [PATCH 3/5] Update pages/docs/tutorials/kafka/bindings-with-kafka.md Co-authored-by: Dale Lane --- pages/docs/tutorials/kafka/bindings-with-kafka.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/tutorials/kafka/bindings-with-kafka.md b/pages/docs/tutorials/kafka/bindings-with-kafka.md index 43d84d02504..1bb9a1cc125 100644 --- a/pages/docs/tutorials/kafka/bindings-with-kafka.md +++ b/pages/docs/tutorials/kafka/bindings-with-kafka.md @@ -106,7 +106,7 @@ operations: Channel bindings provide protocol-specific information for a particular channel. -These configurations may include information about how to connect with the Kafka topic, plus any specific settings or behaviors to be used. The Channel Binding Object is part of AsyncAPI's wider bindings architecture, which specifies how the API interacts with the messaging system — in this case, Kafka. +These configurations may include information how the Kafka topic has been configured. The Channel Binding Object is part of AsyncAPI's wider bindings architecture, which specifies how the API interacts with the messaging system — in this case, Kafka. In Kafka, you can specify a given topic's number of partitions or replicas therefore, enabling parallel processing of data or consumers. Learn more about other fields that you can configure under [channel bindings](https://github.com/asyncapi/bindings/tree/master/kafka#channel-binding-object). From f97c06c4adec752181f130d703dd5860beff224b Mon Sep 17 00:00:00 2001 From: Cynthia Peter Date: Thu, 14 Mar 2024 11:36:11 +0100 Subject: [PATCH 4/5] Update pages/docs/tutorials/kafka/bindings-with-kafka.md Co-authored-by: Dale Lane --- pages/docs/tutorials/kafka/bindings-with-kafka.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/tutorials/kafka/bindings-with-kafka.md b/pages/docs/tutorials/kafka/bindings-with-kafka.md index 1bb9a1cc125..8fbca189ae3 100644 --- a/pages/docs/tutorials/kafka/bindings-with-kafka.md +++ b/pages/docs/tutorials/kafka/bindings-with-kafka.md @@ -139,7 +139,7 @@ If you need to follow specific naming conventions for example, Kafka topic name ## Add message bindings -Message bindings provide protocol-specific information for a specific message. Like the Kafka topic, it's associated with a message key (if any) and Kafka-specific properties. +Message bindings provide protocol-specific information for a specific message. For Kafka topics, this can include how message keys are used, and details about how serialized message data has been encoded. For example, the `schemaIdLocation` field, if specified is used to indicate where the schema identifier (ID) for the message payload's schema is located. It is useful for message serialization and deserialization, enabling consumers to understand how to interpret the message payload. From bc47bf1d12ac33025e68caae171cdd5854495c17 Mon Sep 17 00:00:00 2001 From: Cynthia Peter Date: Thu, 14 Mar 2024 11:36:55 +0100 Subject: [PATCH 5/5] Update pages/docs/tutorials/kafka/bindings-with-kafka.md Valid document Co-authored-by: Lukasz Gornicki --- pages/docs/tutorials/kafka/bindings-with-kafka.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/pages/docs/tutorials/kafka/bindings-with-kafka.md b/pages/docs/tutorials/kafka/bindings-with-kafka.md index 8fbca189ae3..76e7d80b100 100644 --- a/pages/docs/tutorials/kafka/bindings-with-kafka.md +++ b/pages/docs/tutorials/kafka/bindings-with-kafka.md @@ -220,12 +220,12 @@ components: bindings: kafka: bindingVersion: '0.4.0' - key: - type: string - enum: ['myKey'] - schemaIdLocation: 'payload' - schemaIdPayloadEncoding: 'apicurio-new' - schemaLookupStrategy: 'TopicIdStrategy' + key: + type: string + enum: ['myKey'] + schemaIdLocation: 'payload' + schemaIdPayloadEncoding: 'apicurio-new' + schemaLookupStrategy: 'TopicIdStrategy' payload: schemaFormat: 'application/vnd.apache.avro+json;version=1.9.0' schema: