blob: 811a12891883e4278bceacae96274aa2181df304 [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 Shah84e9e3b2017-09-29 15:53:37 +00007
8.. contents::
9 :depth: 2
10
Saryu Shah23ef5bd2017-09-27 14:11:11 +000011The 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 +000012
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
Pamela Dragosh5ed4e852017-09-22 12:26:16 -040025
Saryu Shah23ef5bd2017-09-27 14:11:11 +000026POLICY Engine Services
27^^^^^^^^^^^^^^^^^^^^^^
28
Saryu Shah5c408032017-10-11 21:47:23 +000029.. image:: PolicyEngineApiList.png
Saryu Shah23ef5bd2017-09-27 14:11:11 +000030
Saryu Shah2454de92017-09-26 20:00:17 +000031POLICY API Details
32^^^^^^^^^^^^^^^^^^
Pamela Dragosh5ed4e852017-09-22 12:26:16 -040033
Saryu Shah3eddd582017-10-12 22:03:55 +000034.. swaggerv2doc:: api-docs.json
Saryu Shah2454de92017-09-26 20:00:17 +000035
36
Saryu Shah84e9e3b2017-09-29 15:53:37 +000037Additional Information
38^^^^^^^^^^^^^^^^^^^^^^
Saryu Shah2454de92017-09-26 20:00:17 +000039
Saryu Shah84e9e3b2017-09-29 15:53:37 +000040Additional information, including examples, can be found at `PolicyApi link`_.
Saryu Shah2454de92017-09-26 20:00:17 +000041
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 Shah3198d6d2017-11-07 21:40:27 +000048End of Document
Pamela Dragosh5ed4e852017-09-22 12:26:16 -040049