summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPamela Dragosh <pdragosh@research.att.com>2017-09-25 21:48:31 +0000
committerGerrit Code Review <gerrit@onap.org>2017-09-25 21:48:31 +0000
commit04c6945fea6a17b89affe2e1a1304e03005136b7 (patch)
treeee1a9f1ea55243ad72cd33cd11486c1c5e3db4ab
parent7c5217b44e4f238bb8fc3ce68a046f6c149d07df (diff)
parent32f6b366e4b178b8283d3438625b87ef7408b123 (diff)
Merge "Added api document"
-rw-r--r--docs/platform/offeredapis.rst18
1 files changed, 16 insertions, 2 deletions
diff --git a/docs/platform/offeredapis.rst b/docs/platform/offeredapis.rst
index 43a82000f..728f2ba33 100644
--- a/docs/platform/offeredapis.rst
+++ b/docs/platform/offeredapis.rst
@@ -4,12 +4,26 @@
Offered APIs
============
-List APIs offered. One or more of the following examples may be appropriate.
+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 support by the policy API:
+
+* Create policies on the PAP
+* Update policies on the PAP
+* Delete policies on the PAP or PDP
+* Push policies from the PAP to the PDP
+* List policies on the PDP
+* Get config data of policies on the PDP
+* Create Dictionary Items
+* Update Dictionary Items
+* Retrieve Dictionary Items
+* Import Micro Services Models
+* Retrieve Metrics for policy counts from PDP and PAP
+
+.. SStodo need to include the swaggerv2doc for the api
Example Swagger Displayed with swaggerv2doc directive
-----------------------------------------------------
-.. swaggerv2doc:: http://104.239.197.207:8081/pdp/v2/api-docs
+.. SStodo add swaggerv2doc directive here
End of document