Merge "Added validation on matching required fields"
[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
8 .. contents:: 
9     :depth: 2
10
11 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:
12
13 * Create policies on the PAP 
14 * Update policies on the PAP
15 * Delete policies on the PAP or PDP
16 * Push policies from the PAP to the PDP
17 * List policies on the PDP
18 * Get config data of policies on the PDP
19 * Create Dictionary Items
20 * Update Dictionary Items
21 * Retrieve Dictionary Items
22 * Import Micro Services Models
23 * Retrieve Metrics for policy counts from PDP and PAP
24
25
26 POLICY Engine Services
27 ^^^^^^^^^^^^^^^^^^^^^^
28
29 .. image:: PolicyEngineApiList.png
30
31 POLICY API Details
32 ^^^^^^^^^^^^^^^^^^
33
34 .. swaggerv2doc:: api-docs.json
35
36
37 Additional Information
38 ^^^^^^^^^^^^^^^^^^^^^^
39
40 Additional information, including examples, 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