documentation for using guard in the PDP
[policy/engine.git] / docs / platform / offeredapis.rst
index 728f2ba..811a128 100644 (file)
@@ -4,7 +4,11 @@
 
 Offered APIs
 ============
-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:
+
+.. contents:: 
+    :depth: 2
+
+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:
 
 * Create policies on the PAP 
 * Update policies on the PAP
@@ -18,12 +22,28 @@ The Policy subsystem of ONAP maintains, distributes, and operates on the set of
 * 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
------------------------------------------------------
+POLICY Engine Services
+^^^^^^^^^^^^^^^^^^^^^^
+
+.. image:: PolicyEngineApiList.png
+
+POLICY API Details
+^^^^^^^^^^^^^^^^^^
+
+.. swaggerv2doc:: api-docs.json
+
+
+Additional Information
+^^^^^^^^^^^^^^^^^^^^^^
+
+Additional information, including examples, can be found at `PolicyApi link`_.
+
+.. _PolicyApi link: https://wiki.onap.org/display/DW/Policy+API
+
+
+
 
-.. SStodo add swaggerv2doc directive here
 
-End of document
+End of Document