diff options
author | Chenfei Gao <cgao@research.att.com> | 2019-05-21 17:40:21 -0400 |
---|---|---|
committer | Chenfei Gao <cgao@research.att.com> | 2019-05-21 23:01:25 -0400 |
commit | af35b6a245e1587a3f149746c043fc4520daecaa (patch) | |
tree | 9fc292df0b58bd0625d55f2474c4d2a4c9b79fcc /docs/api/policytypes/onap.policies.optimization.Vim_fit.json | |
parent | 55e1f559eb898e470bb7af9f83fb0ac23069bf34 (diff) |
Add more textual explanation in api doc
Added more textual explanation and tables for
downloading sample policies and preloaded policy types.
Also added sample curl commands for api calls.
Issue-ID: POLICY-1680
Change-Id: Ia98e37679ae8e632da9d1f7308e156f722648faf
Signed-off-by: Chenfei Gao <cgao@research.att.com>
Diffstat (limited to 'docs/api/policytypes/onap.policies.optimization.Vim_fit.json')
-rw-r--r-- | docs/api/policytypes/onap.policies.optimization.Vim_fit.json | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/docs/api/policytypes/onap.policies.optimization.Vim_fit.json b/docs/api/policytypes/onap.policies.optimization.Vim_fit.json new file mode 100644 index 00000000..a7894b3f --- /dev/null +++ b/docs/api/policytypes/onap.policies.optimization.Vim_fit.json @@ -0,0 +1,92 @@ +{ + "tosca_definitions_version": "tosca_simple_yaml_1_0_0", + "policy_types": [ + { + "onap.policies.Optimization": { + "derived_from": "tosca.policies.Root", + "version": "1.0.0", + "description": "a base policy type for all policies that govern optimization" + } + }, + { + "onap.policies.optimization.Vim_fit": { + "derived_from": "onap.policies.Optimization", + "version": "1.0.0", + "properties": { + "policyScope": { + "type": "list", + "description": "scope where the policy is applicable", + "required": true, + "matchable": true, + "entry_schema": { + "type": "string" + } + }, + "policyType": { + "type": "list", + "description": "type of a policy", + "required": true, + "matchable": true, + "entry_schema": { + "type": "string", + "constraints": [ + { + "valid_values": [ + "vim_fit" + ] + } + ] + } + }, + "identity": { + "type": "string", + "required": true + }, + "applicableResources": { + "type": "list", + "required": true, + "entry_schema": { + "type": "string", + "constraints": [ + { + "valid_values": [ + "any", + "all" + ] + } + ] + } + }, + "resources": { + "type": "list", + "required": true, + "entry_schema": { + "type": "string" + } + }, + "capacityProperties": { + "type": "policy.data.capacityProperties_properties", + "required": true + } + } + } + } + ], + "data_types": [ + { + "policy.data.capacityProperties_properties": { + "derived_from": "tosca.nodes.Root", + "properties": { + "controller": { + "type": "string", + "required": true + }, + "request": { + "type": "string", + "required": true + } + } + } + } + ] +} |