diff options
| -rw-r--r-- | docs/pap/pap.rst | 25 | ||||
| -rw-r--r-- | docs/xacml/decision-api.rst | 2 |
2 files changed, 26 insertions, 1 deletions
diff --git a/docs/pap/pap.rst b/docs/pap/pap.rst index 21b5b42b..b2c98ef5 100644 --- a/docs/pap/pap.rst +++ b/docs/pap/pap.rst @@ -166,7 +166,8 @@ are added in the response to each call: "x-minorversion", "0", "MINOR version of the API" "x-patchversion", "0", "PATCH version of the API" "x-onap-requestid", "e1763e61-9eef-4911-b952-1be1edd9812b", "described above; used for logging purposes" - + +:download:`Download Health Check PAP API Swagger <swagger/health-check-pap.json>` .. swaggerv2doc:: swagger/health-check-pap.json @@ -177,6 +178,8 @@ Here is a sample response: .. literalinclude:: response/health-check-pap-resp.json :language: json +:download:`Download Consolidated Health Check PAP API Swagger <swagger/consolidated-healthcheck-pap.json>` + .. swaggerv2doc:: swagger/consolidated-healthcheck-pap.json This operation performs a health check of all policy components. The response @@ -189,6 +192,8 @@ Here is a sample response: .. literalinclude:: response/consolidated-healthcheck-pap-resp.json :language: json +:download:`Download Statistics PAP API Swagger <swagger/statistics-pap.json>` + .. swaggerv2doc:: swagger/statistics-pap.json This operation allows statistics for PDP groups, PDP subgroups, and individual PDPs to be retrieved. @@ -202,11 +207,15 @@ Here is a sample response: .. literalinclude:: response/statistics-pap-resp.json :language: json +:download:`Download State Change PAP Swagger <swagger/state-change-pap.json>` + .. swaggerv2doc:: swagger/state-change-pap.json The state of PDP groups is managed by this operation. PDP groups can be in states PASSIVE, TEST, SAFE, or ACTIVE. For a full description of PDP group states, see the :ref:`ONAP Policy Framework Architecture <architecture-label>` page. +:download:`Download Group Batch PAP API Swagger <swagger/groups-batch-pap.json>` + .. swaggerv2doc:: swagger/groups-batch-pap.json This operation allows the PDP groups and subgroups to be created and updated. Many PDP groups can be created or updated @@ -232,10 +241,14 @@ Here is a sample request: .. literalinclude:: request/groups-batch-pap-req.json :language: json +:download:`Download Group Delete PAP API Swagger <swagger/group-delete-pap.json>` + .. swaggerv2doc:: swagger/group-delete-pap.json The API also allows PDP groups to be deleted. DELETE operations are only permitted on PDP groups in PASSIVE state. +:download:`Download Group Query PAP API Swagger <swagger/group-query-pap.json>` + .. swaggerv2doc:: swagger/group-query-pap.json This operation allows the PDP groups and subgroups to be listed as well as the policies that are deployed on each PDP @@ -246,6 +259,8 @@ Here is a sample response: .. literalinclude:: response/group-query-pap-resp.json :language: json +:download:`Download Deployments Batch PAP API Swagger <swagger/deployments-batch-pap.json>` + .. swaggerv2doc:: swagger/deployments-batch-pap.json This operation allows policies to be deployed on specific PDP groups. @@ -261,6 +276,8 @@ Here is a sample request: .. literalinclude:: request/deployment-batch-pap-req.json :language: json +:download:`Download Deploy PAP API Swagger <swagger/policy-deploy-pap.json>` + .. swaggerv2doc:: swagger/policy-deploy-pap.json This operation allows policies to be deployed across all relevant PDP groups. @@ -278,6 +295,8 @@ Here is a sample request: .. literalinclude:: request/policy-deploy-pap-req.json :language: json +:download:`Download Undeploy PAP API Swagger <swagger/policy-undeploy-pap.json>` + .. swaggerv2doc:: swagger/policy-undeploy-pap.json This operation allows policies to be undeployed from PDP groups. @@ -289,6 +308,8 @@ This operation allows policies to be undeployed from PDP groups. .. note:: Due to current limitations, a fully qualified policy version must always be specified. +:download:`Download Deployed Policy PAP API Swagger <swagger/deployed-policy-pap.json>` + .. swaggerv2doc:: swagger/deployed-policy-pap.json This operation allows the deployed policies to be listed together with their respective deployment status. @@ -299,6 +320,8 @@ Here is a sample response: .. literalinclude:: response/deployed-policy-pap-resp.json :language: json +:download:`Download PDP Statistics PAP API Swagger <swagger/pdp-statistics-pap.json>` + .. swaggerv2doc:: swagger/pdp-statistics-pap.json This operation allows the PDP statistics to be retrieved for all registered PDPs. diff --git a/docs/xacml/decision-api.rst b/docs/xacml/decision-api.rst index e475e1dc..7d068c1e 100644 --- a/docs/xacml/decision-api.rst +++ b/docs/xacml/decision-api.rst @@ -41,6 +41,8 @@ x-patchversion is used only to communicate a PATCH version in a response for tro x-onap-requestid is used to track REST transactions for logging purpose, as described above. +:download:`Download the Decision API Swagger <swagger.json>` + .. swaggerv2doc:: swagger.json |