Update pap document

[policy/parent.git] / docs / pap / pap.rst

diff --git a/docs/pap/pap.rst b/docs/pap/pap.rst
index 0f7c0c6..f46d1c7 100644 (file)
--- a/docs/pap/pap.rst
+++ b/docs/pap/pap.rst
@@ -120,6 +120,7 @@ PAP supports the operations listed in the following table, via its REST API:
    "Policy Status", "Queries the status of all policies"
    "Policy deployment status", "Queries the status of all deployed policies"
    "PDP statistics", "Queries the statistics of PDPs"
+   "Policy Audit", "Queries the audit records of policies"
 
 1.2 DMaaP API
 -------------
@@ -147,7 +148,7 @@ Here is a sample notification:
 2 PAP REST API Swagger
 ======================
 
-It is worth noting that we use basic authorization for access with user name and password set to *healthcheck* and
+It is worth noting that we use basic authorization for access with user name and password set to *policyadmin* and
 *zb!XztG34*, respectively.
 
 For every call, the client is encouraged to insert a uuid-type *requestID* as parameter. It is helpful for tracking each
@@ -363,37 +364,43 @@ Here is a sample response:
 
 This operation allows the PDP statistics to be retrieved for all registered PDPs.
 The result can be filtered based on PDP group, PDP subgroup & PDP instance.
+Along with record count, start time & end time as query parameters.
 
 Here is a sample response:
 
 .. literalinclude:: response/pdp-statistics-pap-resp.json
     :language: json
 
+:download:`Download Policy Audit PAP API Swagger  <swagger/policy-audit-pap.json>`
+
+.. swaggerv2doc:: swagger/policy-audit-pap.json
+
+This operation allows the audit records of policies to be listed together.
+The result can be filtered based on pdp group name, policy name & version.
+Along with record count, start time & end time as query parameters.
+
+Here is a sample response:
+
+.. literalinclude:: response/policy-audit-pap-resp.json
+    :language: json
+
 3 Configuration
 =================
 
+The *PolicyAdministration* component (PAP) is initialized using a configuration file: `papParameters.yaml
+<https://github.com/onap/policy-pap/blob/master/packages/policy-pap-tarball/src/main/resources/etc/papParameters.yaml>`_
+
+The configuration file is a YAML file containing the relevant fields for configuring the REST server, Database and DMaaP connectivity and so on.
+
 3.1 Disable collection of PDP Statistics
 ========================================
 
 This configuration is to inform PAP to not save the PDP statistics in the database.
 
-In `config.json
-<https://github.com/onap/policy-pap/blob/master/packages/policy-pap-tarball/src/main/resources/etc/defaultConfig.json>`_,
-add or change the property savePdpStatisticsInDb to false.
+In *papParameters.yaml*, add or change the property savePdpStatisticsInDb to false.
 
 .. note::
   By default, if the property is not present, it will be considered as false and
   PDP statistics will not be saved in the database.
 
-
-4 Future Features
-=================
-
-4.1 Disable policies in PDP
-===========================
-
-This operation will allow disabling individual policies running in PDP engine. It is mainly beneficial
-in scenarios where network operators/administrators want to disable a particular policy in PDP engine
-for a period of time due to a failure in the system or for scheduled maintenance.
-
 End of Document