Add more textual explanation in api doc
[policy/parent.git] / docs / api / policytypes / onap.policies.optimization.SubscriberPolicy.json
1 {
2     "tosca_definitions_version": "tosca_simple_yaml_1_0_0",
3     "policy_types": [
4         {
5             "onap.policies.Optimization": {
6                 "derived_from": "tosca.policies.Root",
7                 "version": "1.0.0",
8                 "description": "a base policy type for all policies that govern optimization"
9             }
10         },
11         {
12             "onap.policies.optimization.SubscriberPolicy": {
13                 "derived_from": "onap.policies.Optimization",
14                 "version": "1.0.0",
15                 "properties": {
16                     "policyScope": {
17                         "type": "list",
18                         "description": "scope where the policy is applicable",
19                         "required": true,
20                         "matchable": true,
21                         "entry_schema": {
22                             "type": "string"
23                         }
24                     },
25                     "policyType": {
26                         "type": "list",
27                         "description": "type of a policy",
28                         "required": true,
29                         "matchable": true,
30                         "entry_schema": {
31                             "type": "string",
32                             "constraints": [
33                                 {
34                                     "valid_values": [
35                                         "subscriberPolicy"
36                                     ]
37                                 }
38                             ]
39                         }
40                     },
41                     "identity": {
42                         "type": "string",
43                         "required": true
44                     },
45                     "properties": {
46                         "type": "policy.data.properties_properties",
47                         "required": true
48                     }
49                 }
50             }
51         }
52     ],
53     "data_types": [
54         {
55             "policy.data.properties_properties": {
56                 "derived_from": "tosca.nodes.Root",
57                 "properties": {
58                     "subscriberName": {
59                         "type": "list",
60                         "required": true,
61                         "entry_schema": {
62                             "type": "string"
63                         }
64                     },
65                     "subscriberRole": {
66                         "type": "list",
67                         "required": true,
68                         "entry_schema": {
69                             "type": "string"
70                         }
71                     },
72                     "provStatus": {
73                         "type": "list",
74                         "required": true,
75                         "entry_schema": {
76                             "type": "string"
77                         }
78                     }
79                 }
80             }
81         }
82     ]
83 }