From cf6dd0fe2adb1c3c0dafe8d787c236152611d2ea Mon Sep 17 00:00:00 2001 From: Ram Krishna Verma Date: Thu, 25 Aug 2022 17:24:51 -0400 Subject: Update apex-pdp user manual 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 --- docs/apex/APEX-User-Manual.rst | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) (limited to 'docs/apex') diff --git a/docs/apex/APEX-User-Manual.rst b/docs/apex/APEX-User-Manual.rst index eed350ab..21e9dbcb 100644 --- a/docs/apex/APEX-User-Manual.rst +++ b/docs/apex/APEX-User-Manual.rst @@ -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: -- cgit 1.2.3-korg