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.controlloop.guard.Blacklist.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.controlloop.guard.Blacklist.json')
-rw-r--r-- | docs/api/policytypes/onap.policies.controlloop.guard.Blacklist.json | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/docs/api/policytypes/onap.policies.controlloop.guard.Blacklist.json b/docs/api/policytypes/onap.policies.controlloop.guard.Blacklist.json new file mode 100644 index 00000000..9391496c --- /dev/null +++ b/docs/api/policytypes/onap.policies.controlloop.guard.Blacklist.json @@ -0,0 +1,62 @@ +{ + "tosca_definitions_version": "tosca_simple_yaml_1_0_0", + "policy_types": [ + { + "onap.policies.controlloop.Guard": { + "derived_from": "tosca.policies.Root", + "version": "1.0.0", + "description": "Guard Policies for Control Loop Operational Policies" + } + }, + { + "onap.policies.controlloop.guard.Blacklist": { + "derived_from": "onap.policies.controlloop.Guard", + "version": "1.0.0", + "description": "Supports blacklist of VNF's from performing control loop actions on.", + "properties": { + "blacklist_policy": { + "type": "map", + "description": null, + "entry_schema": { + "type": "onap.datatypes.guard.Blacklist" + } + } + } + } + } + ], + "data_types": [ + { + "onap.datatypes.guard.Blacklist": { + "derived_from": "tosca.datatypes.Root", + "properties": { + "actor": { + "type": "string", + "description": "Specifies the Actor", + "required": true + }, + "recipe": { + "type": "string", + "description": "Specified the Recipe", + "required": true + }, + "time_range": { + "type": "tosca.datatypes.TimeInterval", + "description": "An optional range of time during the day the blacklist is valid for.", + "required": false + }, + "controlLoopName": { + "type": "string", + "description": "An optional specific control loop to apply this guard to.", + "required": false + }, + "blacklist": { + "type": "list", + "description": "List of VNF's", + "required": true + } + } + } + } + ] +}
\ No newline at end of file |