"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>`_
"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
-----------
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.
+++ /dev/null
-{
- "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"
- }
- }
- }
- }
-}
============================================ ===============================================================================
onap.policies.Monitoring Base model that supports Policy driven DCAE microservice components used
in Control Loops
-onap.policies.controlloop.Operational Legacy actor/action operational policies for control loops (Deprecated)
onap.policies.controlloop.operational.Common Base Control Loop operational policy common definitions
onap.policies.controlloop.guard.Common Control Loop Guard Policy common definitions
onap.policies.Optimization Base OOF Optimization Policy Type definition
This policy type supports Apex native policy types.
`Apex Native Policy Type <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policytypes/onap.policies.native.Apex.yaml>`_
-
-
-7 Base Policy Type: onap.policies.controlloop.Operational (Deprecated)
-----------------------------------------------------------------------
-
-This policy type is used to support legacy YAML definitions for actor/action operational policies for control loops.
-There are two types of implementations for this policy type:
-
-1. Drools implementations that support runtime Control Loop actions taken on components such as SO/APPC/VFC/SDNC/SDNR
-2. Implementations using APEX to support Control Loops.
-
-.. note::
- This policy type will be deprecated after Frankfurt and is discouraged from being used.
-
-.. code-block:: yaml
- :caption: Base Policy Type definition for onap.policies.controlloop.Operational
- :linenos:
-
- tosca_definitions_version: tosca_simple_yaml_1_1_0
- policy_types:
- - onap.policies.controlloop.Operational:
- derived_from: tosca.policies.Root
- version: 1.0.0
- description: Operational Policy for Control Loops
-
-There are no properties defined for this policy type, instead it is expected that the user submit the REST call with a
-special JSON format used to bridge the Casablanca Legacy API to the new Lifecycle API introduced in Dublin release.
-
-.. code-block:: json
- :caption: Example Policy Payload for onap.policies.controlloop.Operational Policy Type
-
- {
- "policy-id" : "operational.restart",
- "policy-version" : "1",
- "content" : "controlLoop%3A%0A%20%20version%3A%202.0.0%0A%20%20controlLoopName%3A%20ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e%0A%20%20trigger_policy%3A%20unique-policy-id-1-restart%0A%20%20timeout%3A%203600%0A%20%20abatement%3A%20true%0A%20%0Apolicies%3A%0A%20%20-%20id%3A%20unique-policy-id-1-restart%0A%20%20%20%20name%3A%20Restart%20the%20VM%0A%20%20%20%20description%3A%0A%20%20%20%20actor%3A%20APPC%0A%20%20%20%20recipe%3A%20Restart%0A%20%20%20%20target%3A%0A%20%20%20%20%20%20type%3A%20VM%0A%20%20%20%20retry%3A%203%0A%20%20%20%20timeout%3A%201200%0A%20%20%20%20success%3A%20final_success%0A%20%20%20%20failure%3A%20final_failure%0A%20%20%20%20failure_timeout%3A%20final_failure_timeout%0A%20%20%20%20failure_retries%3A%20final_failure_retries%0A%20%20%20%20failure_exception%3A%20final_failure_exception%0A%20%20%20%20failure_guard%3A%20final_failure_guard",
- "controllerName" : "frankfurt"
- }
-
-For the **"content"** property, please refer to the `YAML Operational Policy format
-<https://github.com/onap/policy-models/blob/master/models-interactions/model-yaml/README-v2.0.0.md>`__ to define the
-**content** field and URL Encode the yaml.