diff options
| author |   a.sreekumar <ajith.sreekumar@bell.ca> | 2021-02-19 17:29:40 +0000 |
|---|---|---|
| committer | a.sreekumar <ajith.sreekumar@bell.ca> | 2021-02-19 17:29:46 +0000 |
| commit | e756dc976ccf36bb7b17e13e573fd3e5c9dacab1 (patch) | |
| tree | 7e58690c6de643f2bf6ba36014d822440b5570fe /docs/pap/pap.rst | |
| parent | c13c83c9bd4fc386d05856f0b25a8f3fc1db22c3 (diff) | |
Doc updates for PAP Deployment API changes
Change-Id: I23b8778c599a0fd3cc659f677018d866a68a2489
Issue-ID: POLICY-2526
Signed-off-by: a.sreekumar <ajith.sreekumar@bell.ca>
Diffstat (limited to 'docs/pap/pap.rst')
| -rw-r--r-- | docs/pap/pap.rst | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/pap/pap.rst b/docs/pap/pap.rst index 288a72a1..5329d8fb 100644 --- a/docs/pap/pap.rst +++ b/docs/pap/pap.rst @@ -282,6 +282,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 +306,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 +324,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 |