diff options
| author |   Saryu Shah <ss3917@att.com> | 2017-09-27 14:11:11 +0000 |
|---|---|---|
| committer | Saryu Shah <ss3917@att.com> | 2017-09-27 14:11:11 +0000 |
| commit | 23ef5bd6dcc76023a6d9bf2a89c4052254eeb24e (patch) | |
| tree | 1a51c8e96dba237db3122d54f7798963863178c2 /docs | |
| parent | 2454de95e390461e338c491c37779515bc9b65b6 (diff) | |
Policy api documentation updates
Policy api documentation updates
-------------------------------------------------------------
Change-Id: If6f997ba1a14dbd0d42654993f444632ea4f6301
Issue-Id: POLICY-241
Signed-off-by: Saryu Shah <ss3917@att.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/platform/offeredapis.rst | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/docs/platform/offeredapis.rst b/docs/platform/offeredapis.rst index 7b2e84ea2..6f522635b 100644 --- a/docs/platform/offeredapis.rst +++ b/docs/platform/offeredapis.rst @@ -4,7 +4,7 @@ Offered APIs ============ -The Policy subsystem of ONAP maintains, distributes, and operates on the set of rules that underlie ONAP’s control, orchestration, and management functions. Policy provides a centralized environment for the creation and management of easily-updatable conditional rules. It enables users to validate policies and rules, identify and resolve overlaps and conflicts, and derive additional policies where needed. The following operations are support by the policy API: +The Policy subsystem of ONAP maintains, distributes, and operates on the set of rules that underlie ONAP’s control, orchestration, and management functions. Policy provides a centralized environment for the creation and management of easily-updatable conditional rules. It enables users to validate policies and rules, identify and resolve overlaps and conflicts, and derive additional policies where needed. The following operations are supported by the policy API: * Create policies on the PAP * Update policies on the PAP @@ -19,18 +19,28 @@ The Policy subsystem of ONAP maintains, distributes, and operates on the set of * Retrieve Metrics for policy counts from PDP and PAP +POLICY Engine Services +^^^^^^^^^^^^^^^^^^^^^^ + +The figure below represents the target POLICY Architecture. + +.. image:: https://wiki.onap.org/download/attachments/1015898/PolicyEngineApiList.png?api=v2 + + + POLICY API Details ^^^^^^^^^^^^^^^^^^ -.. SStodo THIS URL NEEDS TO CHANGE - Just testing for now +.. SStodo Check with Pam about if using onap wiki urls are okay. -.. swaggerv2doc:: https://wiki.onap.org/download/attachments/15994235/api-docs.json?api=v2 +.. swaggerv2doc:: https://wiki.onap.org/download/attachments/1015898/api-docs-09192017.json?api=v2 Additional information can be found at `PolicyApi link`_. -.. _PolicyApi link: https://wiki.onap.org/display/DW/Policy +.. _PolicyApi link: https://wiki.onap.org/display/DW/Policy+API + |