Policy api documentation updates

[policy/engine.git] / docs / platform / offeredapis.rst

diff --git a/docs/platform/offeredapis.rst b/docs/platform/offeredapis.rst
index 55e58bd..6f52263 100644 (file)
--- a/docs/platform/offeredapis.rst
+++ b/docs/platform/offeredapis.rst
@@ -4,26 +4,46 @@
 
 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 supported by the policy API:
 
-Example Swagger Displayed with swaggerv2doc directive
------------------------------------------------------
+* 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
 
-.. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=vfc/nfvo/lcm.git;a=blob_plain;f=lcm/swagger/vfc.nslcm.swagger.json
 
+POLICY Engine Services
+^^^^^^^^^^^^^^^^^^^^^^
 
-Example documenting a REST interface with Sphinx httpdomain directive
----------------------------------------------------------------------
+The figure below represents the target POLICY Architecture.
 
-.. http:get:: path
+.. image:: https://wiki.onap.org/download/attachments/1015898/PolicyEngineApiList.png?api=v2
 
-   For more information see `<https://pythonhosted.org/sphinxcontrib-httpdomain>`_
 
 
-Word Document Converted to RST using Pandocs
---------------------------------------------
+POLICY API Details
+^^^^^^^^^^^^^^^^^^
 
-.. toctree:: 
-   :maxdepth: 1
+.. SStodo Check with Pam about if using onap wiki urls are okay.  
+
+.. swaggerv2doc:: https://wiki.onap.org/download/attachments/1015898/api-docs-09192017.json?api=v2
+
+
+
+Additional information can be found at `PolicyApi link`_.
+
+.. _PolicyApi link: https://wiki.onap.org/display/DW/Policy+API
+
+
+
+
+
+End of document
 
-   ../../submodules/appc.git/docs/APPC API Guide/APPC API Guide