From: Ram Krishna Verma <ram_krishna.verma@bell.ca>
Date: Thu, 17 Nov 2022 20:54:42 +0000 (-0500)
Subject: Add documents for KafkaAvroSerializer support in apex-pdp
X-Git-Tag: 3.7.0~9
X-Git-Url: https://gerrit.onap.org/r/gitweb?p=policy%2Fparent.git;a=commitdiff_plain;h=d873084e17de71c8ef61e844083a2e8d4e32773e

Add documents for KafkaAvroSerializer support in apex-pdp

Issue-ID: POLICY-4460
Change-Id: Ica77ff1aafd10b098bdcae72041f3176b29dac40
Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
---

diff --git a/docs/apex/APEX-User-Manual.rst b/docs/apex/APEX-User-Manual.rst
index c0a7aaca..79232042 100644
--- a/docs/apex/APEX-User-Manual.rst
+++ b/docs/apex/APEX-User-Manual.rst
@@ -2626,6 +2626,31 @@ Kafka Input
                   Kindly note that the above Kafka properties is just a reference,
                   and the actual properties required depends on the Kafka server installation.
 
+                  In cases where the message produced in Kafka topic has been serialized using KafkaAvroSerializer,
+                  then the following parameters needs to be additionally added to `KafkaProperties` for the consumer
+                  to have the capability of deserializing the message properly while consuming.
+
+               .. container:: listingblock
+
+                  .. container:: content
+
+                     .. code::
+
+                        [
+                          "value.deserializer",
+                          "io.confluent.kafka.serializers.KafkaAvroDeserializer"
+                        ],
+                        [
+                          "schema.registry.url",
+                          "<url of the schema registry configured in Kafka cluster for registering Avro schemas>"
+                        ]
+
+               .. container:: paragraph
+
+                  For more details on how to setup schema registry for Kafka cluster,
+                  kindly take a look `here <https://github.com/confluentinc/schema-registry/blob/master/README.md>`__.
+
+
 Kafka Output
 ============
                .. container:: paragraph