Update apex-pdp user manual 46/130446/1
authorRam Krishna Verma <ram_krishna.verma@bell.ca>
Thu, 25 Aug 2022 21:24:51 +0000 (17:24 -0400)
committerRam Krishna Verma <ram_krishna.verma@bell.ca>
Thu, 25 Aug 2022 21:25:01 +0000 (17:25 -0400)
Updating the apex-pdp user manual to add
details about JSON schema support.

Issue-ID: POLICY-4298
Change-Id: I1c900cd08f10b30f85370082c77d110655853961
Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
docs/apex/APEX-User-Manual.rst

index eed350a..21e9dbc 100644 (file)
@@ -2036,11 +2036,37 @@ Context Handlers
 
             APEX provides plugins for each of the main areas.
 
-Configure AVRO Schema Handler
-#############################
+Configure Context Schema Handler
+################################
 
             .. container:: paragraph
 
+               There are 2 choices available for defining schema: JSON & AVRO.
+               JSON based schemas are recommended because of the flexibility, better tooling & easier integration.
+
+               The JSON schema handler is added to the configuration as
+               follows:
+
+            .. container:: listingblock
+
+               .. container:: content
+
+                  .. code::
+
+                     "engineServiceParameters":{
+                       "engineParameters":{
+                         "contextParameters":{
+                           "parameterClassName" : "org.onap.policy.apex.context.parameters.ContextParameters",
+                           "schemaParameters":{
+                             "Json":{
+                               "parameterClassName" :
+                                 "org.onap.policy.apex.plugins.context.schema.json.JsonSchemaHelperParameters"
+                             }
+                           }
+                         }
+                       }
+                     }
+
                The AVRO schema handler is added to the configuration as
                follows: