Policy api documentation updates
[policy/engine.git] / docs / platform / offeredapis.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4
5 Offered APIs
6 ============
7 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:
8
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
21
22 POLICY Engine Services
23 ^^^^^^^^^^^^^^^^^^^^^^
24
25 The figure below represents the target POLICY Architecture.
26
27 .. image:: https://wiki.onap.org/download/attachments/1015898/PolicyEngineApiList.png?api=v2
28
29
30
31 POLICY API Details
32 ^^^^^^^^^^^^^^^^^^
33
34 .. SStodo Check with Pam about if using onap wiki urls are okay.  
35
36 .. swaggerv2doc:: https://wiki.onap.org/download/attachments/1015898/api-docs-09192017.json?api=v2
37
38
39
40 Additional information can be found at `PolicyApi link`_.
41
42 .. _PolicyApi link: https://wiki.onap.org/display/DW/Policy+API
43
44
45
46
47
48 End of document
49