blob: 4b3c7fefba64a5e9029c4f50bd6520c79faff3e2 [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 Shah23ef5bd2017-09-27 14:11:11 +000029.. image:: https://wiki.onap.org/download/attachments/1015898/PolicyEngineApiList.png?api=v2
30
31
Saryu Shah2454de92017-09-26 20:00:17 +000032POLICY API Details
33^^^^^^^^^^^^^^^^^^
Pamela Dragosh5ed4e852017-09-22 12:26:16 -040034
Saryu Shah23ef5bd2017-09-27 14:11:11 +000035.. SStodo Check with Pam about if using onap wiki urls are okay.
Saryu Shah2454de92017-09-26 20:00:17 +000036
Saryu Shah23ef5bd2017-09-27 14:11:11 +000037.. swaggerv2doc:: https://wiki.onap.org/download/attachments/1015898/api-docs-09192017.json?api=v2
Saryu Shah2454de92017-09-26 20:00:17 +000038
39
Saryu Shah84e9e3b2017-09-29 15:53:37 +000040Additional Information
41^^^^^^^^^^^^^^^^^^^^^^
Saryu Shah2454de92017-09-26 20:00:17 +000042
Saryu Shah84e9e3b2017-09-29 15:53:37 +000043Additional information, including examples, can be found at `PolicyApi link`_.
Saryu Shah2454de92017-09-26 20:00:17 +000044
Saryu Shah23ef5bd2017-09-27 14:11:11 +000045.. _PolicyApi link: https://wiki.onap.org/display/DW/Policy+API
46
Saryu Shah2454de92017-09-26 20:00:17 +000047
48
49
Pamela Dragosh5ed4e852017-09-22 12:26:16 -040050
Saryu Shah93d709b2017-09-22 18:39:59 +000051End of document
Pamela Dragosh5ed4e852017-09-22 12:26:16 -040052