summaryrefslogtreecommitdiffstats
path: root/docs/api
diff options
context:
space:
mode:
authorRam Krishna Verma <ram_krishna.verma@bell.ca>2020-08-07 16:18:07 -0400
committerRam Krishna Verma <ram_krishna.verma@bell.ca>2020-08-07 16:18:14 -0400
commit078d92c0c0f4d4be3aa8e0b6808380159bd7d9f2 (patch)
tree2f2275896e409f1bc05242f0d3360708340d33db /docs/api
parentff9dca2dc977dd1ee4b089db21d8705f541160a5 (diff)
Removing legacy operational policy from documents
Removing legacy operational policy from design, api & pap documents. Removing HpaDecoder from distribution document. Issue-ID: POLICY-2430 Change-Id: Iba769d5e336218a00a77371ee8a3b480e0bb3eb5 Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/api.rst4
-rw-r--r--docs/api/swagger/operational-policy-api.json400
2 files changed, 0 insertions, 404 deletions
diff --git a/docs/api/api.rst b/docs/api/api.rst
index 990ac9e7..aa31c064 100644
--- a/docs/api/api.rst
+++ b/docs/api/api.rst
@@ -133,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 <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.controlloop.guard.common.FrequencyLimiter.yaml>`_
"Controlloop.Guard.Common.MinMax", `onap.policies.controlloop.guard.common.MinMax.yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.controlloop.guard.common.MinMax.yaml>`_
"Controlloop.Guard.Coordination.FirstBlocksSecond", `onap.policies.controlloop.guard.coordination.FirstBlocksSecond.yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.controlloop.guard.coordination.FirstBlocksSecond.yaml>`_
- "Controlloop.Operational", `onap.policies.controlloop.Operational.yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.controlloop.Operational.yaml>`_
"Controlloop.Operational.Common", `onap.policies.controlloop.operational.Common.yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.controlloop.operational.Common.yaml>`_
"Controlloop.Operational.Common.Apex", `onap.policies.controlloop.operational.common.Apex.yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.controlloop.operational.common.Apex.yaml>`_
"Controlloop.Operational.Common.Drools", `onap.policies.controlloop.operational.common.Drools.yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.controlloop.operational.common.Drools.yaml>`_
@@ -181,7 +180,6 @@ Global API Table
"Statistics API", ":download:`link <swagger/statistics-api.json>`"
"Tosca Policy Type API", ":download:`link <swagger/policytype-api.json>`"
"Tosca Policy API", ":download:`link <swagger/policy-api.json>`"
- "Legacy Operational Policy API", ":download:`link <swagger/operational-policy-api.json>`"
API Swagger
-----------
@@ -256,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.
diff --git a/docs/api/swagger/operational-policy-api.json b/docs/api/swagger/operational-policy-api.json
deleted file mode 100644
index 90a0e517..00000000
--- a/docs/api/swagger/operational-policy-api.json
+++ /dev/null
@@ -1,400 +0,0 @@
-{
- "swagger" : "2.0",
- "basePath" : "/",
- "tags" : [ {
- "name" : "Legacy Operational Policy"
- } ],
- "schemes" : [ "http", "https" ],
- "paths" : {
- "/policy/api/v1/policytypes/onap.policies.controlloop.Operational/versions/1.0.0/policies/{policyId}/versions/latest" : {
- "get" : {
- "tags" : [ "Legacy Operational Policy" ],
- "summary" : "Retrieve the latest version of a particular operational policy",
- "description" : "Returns the latest version of the specified operational policy",
- "operationId" : "getLatestVersionOfOperationalPolicy",
- "produces" : [ "application/json", "application/yaml" ],
- "parameters" : [ {
- "name" : "policyId",
- "in" : "path",
- "description" : "ID of policy",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "X-ONAP-RequestID",
- "in" : "header",
- "description" : "RequestID for http transaction",
- "required" : false,
- "type" : "string",
- "format" : "uuid"
- } ],
- "responses" : {
- "200" : {
- "description" : "successful operation; Latest version of specified operational policy will be returned.",
- "headers" : {
- "X-MinorVersion" : {
- "type" : "string",
- "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion" : {
- "type" : "string",
- "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion" : {
- "type" : "string",
- "description" : "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID" : {
- "type" : "string",
- "format" : "uuid",
- "description" : "Used to track REST transactions for logging purpose"
- }
- },
- "schema" : {
- "$ref" : "#/definitions/LegacyOperationalPolicy"
- }
- },
- "401" : {
- "description" : "Authentication Error"
- },
- "403" : {
- "description" : "Authorization Error"
- },
- "404" : {
- "description" : "Resource Not Found"
- },
- "500" : {
- "description" : "Internal Server Error"
- }
- },
- "security" : [ {
- "basicAuth" : [ ]
- } ],
- "x-interface info" : {
- "api-version" : "1.0.0",
- "last-mod-release" : "Dublin"
- }
- }
- },
- "/policy/api/v1/policytypes/onap.policies.controlloop.Operational/versions/1.0.0/policies/{policyId}/versions/deployed" : {
- "get" : {
- "tags" : [ "Legacy Opereational Policy" ],
- "summary" : "Retrieve deployed versions of a particular operational policy in pdp groups",
- "description" : "Returns deployed versions of a specified operational policy in pdp groups",
- "operationId" : "getDeployedVersionsOfOperationalPolicy",
- "produces" : [ "application/json", "application/yaml" ],
- "parameters" : [ {
- "name" : "policyId",
- "in" : "path",
- "description" : "ID of operational policy",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "X-ONAP-RequestID",
- "in" : "header",
- "description" : "RequestID for http transaction",
- "required" : false,
- "type" : "string",
- "format" : "uuid"
- } ],
- "responses" : {
- "200" : {
- "description" : "successful operation; Deployed versions of specified operational policy in PDP groups will be returned.",
- "headers" : {
- "X-MinorVersion" : {
- "type" : "string",
- "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion" : {
- "type" : "string",
- "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion" : {
- "type" : "string",
- "description" : "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID" : {
- "type" : "string",
- "format" : "uuid",
- "description" : "Used to track REST transactions for logging purpose"
- }
- },
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/definitions/LegacyOperationalPolicy"
- }
- }
- },
- "401" : {
- "description" : "Authentication Error"
- },
- "403" : {
- "description" : "Authorization Error"
- },
- "404" : {
- "description" : "Resource Not Found"
- },
- "500" : {
- "description" : "Internal Server Error"
- }
- },
- "security" : [ {
- "basicAuth" : [ ]
- } ],
- "x-interface info" : {
- "api-version" : "1.0.0",
- "last-mod-release" : "Dublin"
- }
- }
- },
- "/policy/api/v1/policytypes/onap.policies.controlloop.Operational/versions/1.0.0/policies/{policyId}/versions/{policyVersion}" : {
- "get" : {
- "tags" : [ "Legacy Operational Policy" ],
- "summary" : "Retrieve one version of a particular operational policy",
- "description" : "Returns a particular version of a specified operational policy",
- "operationId" : "getSpecificVersionOfOperationalPolicy",
- "produces" : [ "application/json", "application/yaml" ],
- "parameters" : [ {
- "name" : "policyId",
- "in" : "path",
- "description" : "ID of policy",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "policyVersion",
- "in" : "path",
- "description" : "Version of policy",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "X-ONAP-RequestID",
- "in" : "header",
- "description" : "RequestID for http transaction",
- "required" : false,
- "type" : "string",
- "format" : "uuid"
- } ],
- "responses" : {
- "200" : {
- "description" : "successful operation; Specified version of specified operational policy will be returned.",
- "headers" : {
- "X-MinorVersion" : {
- "type" : "string",
- "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion" : {
- "type" : "string",
- "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion" : {
- "type" : "string",
- "description" : "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID" : {
- "type" : "string",
- "format" : "uuid",
- "description" : "Used to track REST transactions for logging purpose"
- }
- },
- "schema" : {
- "$ref" : "#/definitions/LegacyOperationalPolicy"
- }
- },
- "401" : {
- "description" : "Authentication Error"
- },
- "403" : {
- "description" : "Authorization Error"
- },
- "404" : {
- "description" : "Resource Not Found"
- },
- "500" : {
- "description" : "Internal Server Error"
- }
- },
- "security" : [ {
- "basicAuth" : [ ]
- } ],
- "x-interface info" : {
- "api-version" : "1.0.0",
- "last-mod-release" : "Dublin"
- }
- },
- "delete" : {
- "tags" : [ "Legacy Operational Policy" ],
- "summary" : "Delete a particular version of a specified operational policy",
- "description" : "Delete a particular version of an operational policy. It must follow one rule. Rule: the version that has been deployed in PDP group(s) cannot be deleted",
- "operationId" : "deleteSpecificVersionOfOperationalPolicy",
- "produces" : [ "application/json", "application/yaml" ],
- "parameters" : [ {
- "name" : "policyId",
- "in" : "path",
- "description" : "ID of policy",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "policyVersion",
- "in" : "path",
- "description" : "Version of policy",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "X-ONAP-RequestID",
- "in" : "header",
- "description" : "RequestID for http transaction",
- "required" : false,
- "type" : "string",
- "format" : "uuid"
- } ],
- "responses" : {
- "200" : {
- "description" : "successful operation; Newly deleted operational policy will be returned.",
- "headers" : {
- "X-MinorVersion" : {
- "type" : "string",
- "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion" : {
- "type" : "string",
- "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion" : {
- "type" : "string",
- "description" : "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID" : {
- "type" : "string",
- "format" : "uuid",
- "description" : "Used to track REST transactions for logging purpose"
- }
- },
- "schema" : {
- "$ref" : "#/definitions/LegacyOperationalPolicy"
- }
- },
- "401" : {
- "description" : "Authentication Error"
- },
- "403" : {
- "description" : "Authorization Error"
- },
- "404" : {
- "description" : "Resource Not Found"
- },
- "409" : {
- "description" : "Delete Conflict, Rule Violation"
- },
- "500" : {
- "description" : "Internal Server Error"
- }
- },
- "security" : [ {
- "basicAuth" : [ ]
- } ],
- "x-interface info" : {
- "api-version" : "1.0.0",
- "last-mod-release" : "Dublin"
- }
- }
- },
- "/policy/api/v1/policytypes/onap.policies.controlloop.Operational/versions/1.0.0/policies" : {
- "post" : {
- "tags" : [ "Legacy Operational Policy" ],
- "summary" : "Create a new operational policy",
- "description" : "Create a new operational policy. Client should provide entity body of the new operational policy",
- "operationId" : "createOperationalPolicy",
- "consumes" : [ "application/json", "application/yaml" ],
- "produces" : [ "application/json", "application/yaml" ],
- "parameters" : [ {
- "name" : "X-ONAP-RequestID",
- "in" : "header",
- "description" : "RequestID for http transaction",
- "required" : false,
- "type" : "string",
- "format" : "uuid"
- }, {
- "in" : "body",
- "name" : "body",
- "description" : "Entity body of policy",
- "required" : true,
- "type" : "ToscaServiceTemplate",
- "schema" : {
- "$ref" : "#/definitions/LegacyOperationalPolicy"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "successful operation; Newly created operational policy will be returned.",
- "headers" : {
- "X-MinorVersion" : {
- "type" : "string",
- "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion" : {
- "type" : "string",
- "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion" : {
- "type" : "string",
- "description" : "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID" : {
- "type" : "string",
- "format" : "uuid",
- "description" : "Used to track REST transactions for logging purpose"
- }
- },
- "schema" : {
- "$ref" : "#/definitions/LegacyOperationalPolicy"
- }
- },
- "400" : {
- "description" : "Invalid Body"
- },
- "401" : {
- "description" : "Authentication Error"
- },
- "403" : {
- "description" : "Authorization Error"
- },
- "406" : {
- "description" : "Not Acceptable Version"
- },
- "500" : {
- "description" : "Internal Server Error"
- }
- },
- "security" : [ {
- "basicAuth" : [ ]
- } ],
- "x-interface info" : {
- "api-version" : "1.0.0",
- "last-mod-release" : "Dublin"
- }
- }
- }
- },
- "securityDefinitions" : {
- "basicAuth" : {
- "description" : "",
- "type" : "basic"
- }
- },
- "definitions" : {
- "LegacyOperationalPolicy" : {
- "type" : "object",
- "properties" : {
- "policy-id" : {
- "type" : "string"
- },
- "policy-version" : {
- "type" : "string"
- },
- "content" : {
- "type" : "string"
- }
- }
- }
- }
-}