summaryrefslogtreecommitdiffstats
path: root/docs/pap/pap.rst
diff options
context:
space:
mode:
authorRam Krishna Verma <ram_krishna.verma@bell.ca>2021-07-28 17:19:45 -0400
committerRam Krishna Verma <ram_krishna.verma@bell.ca>2021-07-28 17:22:27 -0400
commitaa234b2a0f4ed58e83b2aa6d1d353a3c6ea68921 (patch)
treea4a9373bbefff242a63c12c1db19e6a1f603591a /docs/pap/pap.rst
parent98b5969b275c63c24fa3ec84d8052b7a49fe7bc3 (diff)
Add document for policy audit api's
Adding section for policy audit api's in pap. Issue-ID: POLICY-3340 Change-Id: I33b572372a5279ef03bc48b62d524dfd15c49c28 Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
Diffstat (limited to 'docs/pap/pap.rst')
-rw-r--r--docs/pap/pap.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/pap/pap.rst b/docs/pap/pap.rst
index 0f7c0c61..d3cbf8bc 100644
--- 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
-------------
@@ -369,6 +370,19 @@ 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, from date & to date as query parameters.
+
+Here is a sample response:
+
+.. literalinclude:: response/policy-audit-pap-resp.json
+ :language: json
+
3 Configuration
=================