X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fpap%2Fpap.rst;h=fe2288bd14fd16d28a35e8f47927a9e390a2cadf;hb=e2528a77fc0db9b2bf7acc72ed61e589dcdb38f7;hp=288a72a106f4f43137fb3ab8241953b13477744f;hpb=f90bf9df87593e4b3ffa6cec3699a92544adf977;p=policy%2Fparent.git diff --git a/docs/pap/pap.rst b/docs/pap/pap.rst index 288a72a1..fe2288bd 100644 --- 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 ` .. 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 ` .. 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 ` + +.. 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 ` .. swaggerv2doc:: swagger/deployed-policy-pap.json