diff options
| author |   Ram Krishna Verma <ram_krishna.verma@bell.ca> | 2022-08-25 17:24:51 -0400 |
|---|---|---|
| committer | Ram Krishna Verma <ram_krishna.verma@bell.ca> | 2022-08-25 17:25:01 -0400 |
| commit | cf6dd0fe2adb1c3c0dafe8d787c236152611d2ea (patch) | |
| tree | fd04cd8f63fa7de0727c843956ca629f58b92f8a /docs/apex | |
| parent | 3681003052058b6a0577e4a693acb8d28bea7497 (diff) | |
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 <ram_krishna.verma@bell.ca>
Diffstat (limited to 'docs/apex')
| -rw-r--r-- | docs/apex/APEX-User-Manual.rst | 30 |
1 files changed, 28 insertions, 2 deletions
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: |