X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi%2Fapi.rst;h=aa31c06492ac76d22922b791e6946300cede6b44;hb=078d92c0c0f4d4be3aa8e0b6808380159bd7d9f2;hp=58f7e9e0dd7da093975bcf8dbb8904c9a3c46576;hpb=4166130f56832fc5063838d142072e3b4c6db349;p=policy%2Fparent.git diff --git a/docs/api/api.rst b/docs/api/api.rst index 58f7e9e0..aa31c064 100644 --- a/docs/api/api.rst +++ b/docs/api/api.rst @@ -2,9 +2,6 @@ .. Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. DO NOT REMOVE THIS LABEL - EVEN IF IT GENERATES A WARNING -.. _offeredapis: - .. THIS IS USED INTERNALLY IN POLICY ONLY .. _api-label: @@ -136,7 +133,6 @@ To ease policy creation, we preload several widely used policy types in policy d "Controlloop.Guard.Common.FrequencyLimiter", `onap.policies.controlloop.guard.common.FrequencyLimiter.yaml `_ "Controlloop.Guard.Common.MinMax", `onap.policies.controlloop.guard.common.MinMax.yaml `_ "Controlloop.Guard.Coordination.FirstBlocksSecond", `onap.policies.controlloop.guard.coordination.FirstBlocksSecond.yaml `_ - "Controlloop.Operational", `onap.policies.controlloop.Operational.yaml `_ "Controlloop.Operational.Common", `onap.policies.controlloop.operational.Common.yaml `_ "Controlloop.Operational.Common.Apex", `onap.policies.controlloop.operational.common.Apex.yaml `_ "Controlloop.Operational.Common.Drools", `onap.policies.controlloop.operational.common.Drools.yaml `_ @@ -184,7 +180,6 @@ Global API Table "Statistics API", ":download:`link `" "Tosca Policy Type API", ":download:`link `" "Tosca Policy API", ":download:`link `" - "Legacy Operational Policy API", ":download:`link `" API Swagger ----------- @@ -259,8 +254,6 @@ To be specific, the following rules are implemented to enforce the version: also includes "policy-id": "sample-policy-name2" and "policy-version": "2.0.0". The 200 return of this POST call will have this created policy with metadata including "policy-id": "sample-policy-name1" and "policy-version": "1.0.0". -.. swaggerv2doc:: swagger/operational-policy-api.json - Regarding DELETE APIs for TOSCA compliant policies, we only expose API to delete one particular version of policy or policy type at a time for safety purpose. If client has the need to delete multiple or a group of policies or policy types, they will need to delete them one by one. @@ -291,3 +284,12 @@ Get vFirewall Operational Policy:: Delete vFirewall Operational Policy:: curl --user 'healthcheck:zb!XztG34' -X DELETE "http://{ip}:{port}/policy/api/v1/policytypes/onap.policies.controlloop.operational.common.Drools/versions/1.0.0/policies/operational.modifyconfig/versions/1.0.0" -H "Accept: application/json" -H "Content-Type: application/json" + +Get all available policies:: + curl --user 'healthcheck:zb!XztG34' -X GET "http://{ip}:{port}/policy/api/v1/policies" -H "Accept: application/json" -H "Content-Type: application/json" + +Get version 1.0.0 of vFirewall Monitoring Policy:: + curl --user 'healthcheck:zb!XztG34' -X GET "http://{ip}:{port}/policy/api/v1/policies/onap.vfirewall.tca/versions/1.0.0" -H "Accept: application/json" -H "Content-Type: application/json" + +Delete version 1.0.0 of vFirewall Monitoring Policy:: + curl --user 'healthcheck:zb!XztG34' -X DELETE "http://{ip}:{port}/policy/api/v1/policies/onap.vfirewall.tca/versions/1.0.0" -H "Accept: application/json" -H "Content-Type: application/json"