Add more textual explanation in api doc
[policy/parent.git] / docs / api / policytypes / onap.policies.optimization.PciPolicy.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.PciPolicy": {
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                                         "pciPolicy"
36                                     ]
37                                 }
38                             ]
39                         }
40                     },
41                     "identity": {
42                         "type": "string",
43                         "required": true
44                     },
45                     "resources": {
46                         "type": "list",
47                         "required": true,
48                         "entry_schema": {
49                             "type": "string"
50                         }
51                     },
52                     "pciProperties": {
53                         "type": "list",
54                         "required": false,
55                         "entry_schema": {
56                             "type": "policy.data.pciProperties_properties"
57                         }
58                     }
59                 }
60             }
61         }
62     ],
63     "data_types": [
64         {
65             "policy.data.pciProperties_properties": {
66                 "derived_from": "tosca.nodes.Root",
67                 "properties": {
68                     "algoCategory": {
69                         "type": "string",
70                         "required": false
71                     },
72                     "pciOptmizationAlgoName": {
73                         "type": "string",
74                         "required": false
75                     },
76                     "pciOptimizationNwConstraint": {
77                         "type": "string",
78                         "required": false
79                     },
80                     "pciOptimizationPriority": {
81                         "type": "string",
82                         "required": false
83                     },
84                     "pciOptimizationTimeConstraint": {
85                         "type": "string",
86                         "required": false
87                     }
88                 }
89             }
90         }
91     ]
92 }