Fixing a formatting issue in PAP Deployment API changes documentation

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

diff --git a/docs/pap/pap.rst b/docs/pap/pap.rst
index 288a72a..fe2288b 100644 (file)
--- a/docs/pap/pap.rst
+++ b/docs/pap/pap.rst
@@ -117,6 +117,7 @@ PAP supports the operations listed in the following table, via its REST API:
    "Deployment update", "Deploy/undeploy one or more policies in specified PdpGroups"
    "Deploy policy", "Deploys one or more policies to the PDPs"
    "Undeploy policy", "Undeploys a policy from the PDPs"
+   "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"
 
@@ -282,6 +283,11 @@ Here is a sample request:
 .. literalinclude:: request/deployment-batch-pap-req.json
     :language: json
 
+Here is a sample response:
+
+.. literalinclude:: response/deployment-pap-resp.json
+    :language: json
+
 :download:`Download Deploy PAP API Swagger  <swagger/policy-deploy-pap.json>`
 
 .. swaggerv2doc:: swagger/policy-deploy-pap.json
@@ -301,6 +307,11 @@ Here is a sample request:
 .. literalinclude:: request/policy-deploy-pap-req.json
     :language: json
 
+Here is a sample response:
+
+.. literalinclude:: response/deployment-pap-resp.json
+    :language: json
+
 :download:`Download Undeploy PAP API Swagger  <swagger/policy-undeploy-pap.json>`
 
 .. swaggerv2doc:: swagger/policy-undeploy-pap.json
@@ -314,6 +325,26 @@ This operation allows policies to be undeployed from PDP groups.
 .. note::
   Due to current limitations, a fully qualified policy version must always be specified.
 
+Here is a sample response:
+
+.. literalinclude:: response/deployment-pap-resp.json
+    :language: json
+
+:download:`Download Policy Status PAP API Swagger  <swagger/policy-status-pap.json>`
+
+.. swaggerv2doc:: swagger/policy-status-pap.json
+
+This operation allows the status of all policies that are deployed or undeployed to be listed together.
+The result can be filtered based on pdp group name, policy name & version.
+
+.. note::
+  When a policy is successfully undeployed, it will no longer appear in the policy status response.
+
+Here is a sample response:
+
+.. literalinclude:: response/policy-status-pap-resp.json
+    :language: json
+
 :download:`Download Deployed Policy PAP API Swagger  <swagger/deployed-policy-pap.json>`
 
 .. swaggerv2doc:: swagger/deployed-policy-pap.json