diff options
| author |   Saryu Shah <ss3917@att.com> | 2017-09-24 15:29:03 +0000 |
|---|---|---|
| committer | Saryu Shah <ss3917@att.com> | 2017-09-24 15:29:03 +0000 |
| commit | 32f6b366e4b178b8283d3438625b87ef7408b123 (patch) | |
| tree | e448590795dd2668a7ac62b908c7509bb355a4bb /docs/platform/offeredapis.rst | |
| parent | 93d709b34c63059495d6bb2e2793dfc3f9ceb361 (diff) | |
Added api document
Testing the api document for policy
-------------------------------------------------------------
Issue-Id: POLICY-241
Change-Id: I7b943b147fb51805dbd6d38723d684817ac37912
Signed-off-by: Saryu Shah <ss3917@att.com>
Diffstat (limited to 'docs/platform/offeredapis.rst')
| -rw-r--r-- | docs/platform/offeredapis.rst | 18 |
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 |