blob: 6f522635bf6fb00734695e645321db603c6d9c8d [file] [log] [blame]
Pamela Dragosh5ed4e852017-09-22 12:26:16 -04001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3
4
5Offered APIs
6============
Saryu Shah23ef5bd2017-09-27 14:11:11 +00007The Policy subsystem of ONAP maintains, distributes, and operates on the set of rules that underlie ONAPs 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:
Saryu Shah32f6b362017-09-24 15:29:03 +00008
9* Create policies on the PAP
10* Update policies on the PAP
11* Delete policies on the PAP or PDP
12* Push policies from the PAP to the PDP
13* List policies on the PDP
14* Get config data of policies on the PDP
15* Create Dictionary Items
16* Update Dictionary Items
17* Retrieve Dictionary Items
18* Import Micro Services Models
19* Retrieve Metrics for policy counts from PDP and PAP
20
Pamela Dragosh5ed4e852017-09-22 12:26:16 -040021
Saryu Shah23ef5bd2017-09-27 14:11:11 +000022POLICY Engine Services
23^^^^^^^^^^^^^^^^^^^^^^
24
25The figure below represents the target POLICY Architecture.
26
27.. image:: https://wiki.onap.org/download/attachments/1015898/PolicyEngineApiList.png?api=v2
28
29
30
Saryu Shah2454de92017-09-26 20:00:17 +000031POLICY API Details
32^^^^^^^^^^^^^^^^^^
Pamela Dragosh5ed4e852017-09-22 12:26:16 -040033
Saryu Shah23ef5bd2017-09-27 14:11:11 +000034.. SStodo Check with Pam about if using onap wiki urls are okay.
Saryu Shah2454de92017-09-26 20:00:17 +000035
Saryu Shah23ef5bd2017-09-27 14:11:11 +000036.. swaggerv2doc:: https://wiki.onap.org/download/attachments/1015898/api-docs-09192017.json?api=v2
Saryu Shah2454de92017-09-26 20:00:17 +000037
38
39
40Additional information can be found at `PolicyApi link`_.
41
Saryu Shah23ef5bd2017-09-27 14:11:11 +000042.. _PolicyApi link: https://wiki.onap.org/display/DW/Policy+API
43
Saryu Shah2454de92017-09-26 20:00:17 +000044
45
46
Pamela Dragosh5ed4e852017-09-22 12:26:16 -040047
Saryu Shah93d709b2017-09-22 18:39:59 +000048End of document
Pamela Dragosh5ed4e852017-09-22 12:26:16 -040049