From 0f079d2fa0cc68c3a682e0e0f73511dd576066ba Mon Sep 17 00:00:00 2001 From: Jim Hahn Date: Thu, 1 Aug 2019 11:05:24 -0400 Subject: Add sample requests and responses to PAP docs Change-Id: I8f2643216bcc8fb2f64dd50296570ab41ea6423c Issue-ID: POLICY-1865 Signed-off-by: Jim Hahn --- docs/pap/response/group-query-pap-resp.json | 190 +++++++++++++++++++++++++++ docs/pap/response/health-check-pap-resp.json | 7 + docs/pap/response/statistics-pap-resp.json | 11 ++ 3 files changed, 208 insertions(+) create mode 100644 docs/pap/response/group-query-pap-resp.json create mode 100644 docs/pap/response/health-check-pap-resp.json create mode 100644 docs/pap/response/statistics-pap-resp.json (limited to 'docs/pap/response') diff --git a/docs/pap/response/group-query-pap-resp.json b/docs/pap/response/group-query-pap-resp.json new file mode 100644 index 00000000..eb8b1dbe --- /dev/null +++ b/docs/pap/response/group-query-pap-resp.json @@ -0,0 +1,190 @@ +{ + "groups": [ + { + "description": "This group should be used for managing all control loop related policies and pdps", + "name": "controlloop", + "pdpGroupState": "ACTIVE", + "pdpSubgroups": [ + { + "currentInstanceCount": 0, + "desiredInstanceCount": 1, + "pdpInstances": [], + "pdpType": "apex", + "policies": [], + "properties": {}, + "supportedPolicyTypes": [ + { + "name": "onap.policies.controlloop.Operational", + "version": "1.0.0" + } + ] + }, + { + "currentInstanceCount": 0, + "desiredInstanceCount": 1, + "pdpInstances": [], + "pdpType": "drools", + "policies": [], + "properties": {}, + "supportedPolicyTypes": [ + { + "name": "onap.policies.controlloop.Operational", + "version": "1.0.0" + } + ] + }, + { + "currentInstanceCount": 0, + "desiredInstanceCount": 1, + "pdpInstances": [], + "pdpType": "xacml", + "policies": [], + "properties": {}, + "supportedPolicyTypes": [ + { + "name": "onap.policies.controlloop.Guard", + "version": "1.0.0" + } + ] + } + ], + "properties": {} + }, + { + "description": "This group should be used for managing all monitoring related policies and pdps", + "name": "monitoring", + "pdpGroupState": "ACTIVE", + "pdpSubgroups": [ + { + "currentInstanceCount": 0, + "desiredInstanceCount": 1, + "pdpInstances": [], + "pdpType": "xacml", + "policies": [], + "properties": {}, + "supportedPolicyTypes": [ + { + "name": "onap.policies.Monitoring", + "version": "1.0.0" + } + ] + } + ], + "properties": {} + }, + { + "description": "The default group that registers all supported policy types and pdps.", + "name": "defaultGroup", + "pdpGroupState": "ACTIVE", + "pdpSubgroups": [ + { + "currentInstanceCount": 0, + "desiredInstanceCount": 1, + "pdpInstances": [], + "pdpType": "apex", + "policies": [], + "properties": {}, + "supportedPolicyTypes": [ + { + "name": "onap.policies.controlloop.operational.Apex", + "version": "1.0.0" + } + ] + }, + { + "currentInstanceCount": 0, + "desiredInstanceCount": 1, + "pdpInstances": [], + "pdpType": "drools", + "policies": [], + "properties": {}, + "supportedPolicyTypes": [ + { + "name": "onap.policies.controlloop.Operational", + "version": "1.0.0" + } + ] + }, + { + "currentInstanceCount": 0, + "desiredInstanceCount": 1, + "pdpInstances": [], + "pdpType": "xacml", + "policies": [], + "properties": {}, + "supportedPolicyTypes": [ + { + "name": "onap.policies.controlloop.guard.FrequencyLimiter", + "version": "1.0.0" + }, + { + "name": "onap.policies.controlloop.guard.MinMax", + "version": "1.0.0" + }, + { + "name": "onap.policies.controlloop.guard.Blacklist", + "version": "1.0.0" + }, + { + "name": "onap.policies.controlloop.guard.coordination.FirstBlocksSecond", + "version": "1.0.0" + }, + { + "name": "onap.Monitoring", + "version": "1.0.0" + }, + { + "name": "onap.policies.monitoring.cdap.tca.hi.lo.app", + "version": "1.0.0" + }, + { + "name": "onap.policies.monitoring.dcaegen2.collectors.datafile.datafile-app-server", + "version": "1.0.0" + }, + { + "name": "onap.policies.monitoring.docker.sonhandler.app", + "version": "1.0.0" + }, + { + "name": "onap.policies.optimization.AffinityPolicy", + "version": "1.0.0" + }, + { + "name": "onap.policies.optimization.DistancePolicy", + "version": "1.0.0" + }, + { + "name": "onap.policies.optimization.HpaPolicy", + "version": "1.0.0" + }, + { + "name": "onap.policies.optimization.OptimizationPolicy", + "version": "1.0.0" + }, + { + "name": "onap.policies.optimization.PciPolicy", + "version": "1.0.0" + }, + { + "name": "onap.policies.optimization.QueryPolicy", + "version": "1.0.0" + }, + { + "name": "onap.policies.optimization.SubscriberPolicy", + "version": "1.0.0" + }, + { + "name": "onap.policies.optimization.Vim_fit", + "version": "1.0.0" + }, + { + "name": "onap.policies.optimization.VnfPolicy", + "version": "1.0.0" + } + ] + } + ], + "properties": {} + } + ] +} diff --git a/docs/pap/response/health-check-pap-resp.json b/docs/pap/response/health-check-pap-resp.json new file mode 100644 index 00000000..faebbe06 --- /dev/null +++ b/docs/pap/response/health-check-pap-resp.json @@ -0,0 +1,7 @@ +{ + "code": 200, + "healthy": true, + "message": "alive", + "name": "Policy PAP", + "url": "self" +} diff --git a/docs/pap/response/statistics-pap-resp.json b/docs/pap/response/statistics-pap-resp.json new file mode 100644 index 00000000..836b5956 --- /dev/null +++ b/docs/pap/response/statistics-pap-resp.json @@ -0,0 +1,11 @@ +{ + "code": 200, + "policyDeployFailureCount": 0, + "policyDeploySuccessCount": 0, + "policyDownloadFailureCount": 0, + "policyDownloadSuccessCount": 0, + "totalPdpCount": 0, + "totalPdpGroupCount": 0, + "totalPolicyDeployCount": 0, + "totalPolicyDownloadCount": 0 +} -- cgit 1.2.3-korg