Add more textual explanation in api doc
[policy/parent.git] / docs / api / policytypes / onap.policies.optimization.AffinityPolicy.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.AffinityPolicy": {
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                                         "zone"
36                                     ]
37                                 }
38                             ]
39                         }
40                     },
41                     "identity": {
42                         "type": "string",
43                         "required": true
44                     },
45                     "applicableResources": {
46                         "type": "list",
47                         "required": true,
48                         "entry_schema": {
49                             "type": "string",
50                             "constraints": [
51                                 {
52                                     "valid_values": [
53                                         "any",
54                                         "all"
55                                     ]
56                                 }
57                             ]
58                         }
59                     },
60                     "affinityProperties": {
61                         "type": "policy.data.affinityProperties_properties",
62                         "required": true
63                     },
64                     "resources": {
65                         "type": "list",
66                         "required": true,
67                         "entry_schema": {
68                             "type": "string"
69                         }
70                     }
71                 }
72             }
73         }
74     ],
75     "data_types": [
76         {
77             "policy.data.affinityProperties_properties": {
78                 "derived_from": "tosca.nodes.Root",
79                 "properties": {
80                     "qualifier": {
81                         "type": "list",
82                         "required": true,
83                         "entry_schema": {
84                             "type": "string",
85                             "constraints": [
86                                 {
87                                     "valid_values": [
88                                         "same",
89                                         "different"
90                                     ]
91                                 }
92                             ]
93                         }
94                     },
95                     "category": {
96                         "type": "string",
97                         "required": true
98                     }
99                 }
100             }
101         }
102     ]
103 }