From 5feb3ac516c597b3325afd1f7dcb32104da289df Mon Sep 17 00:00:00 2001 From: Liang Chen Date: Wed, 18 Sep 2013 15:47:43 +0800 Subject: [PATCH] Document nested stack properties This adds descriptions to the nested stack properties. Fixes bug #1224150 Change-Id: I04a74f17e8e7ffc2a2d2bd0de333b103ee831744 --- heat/engine/resources/stack.py | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/heat/engine/resources/stack.py b/heat/engine/resources/stack.py index 15f5e26c..9505da6b 100644 --- a/heat/engine/resources/stack.py +++ b/heat/engine/resources/stack.py @@ -34,10 +34,20 @@ class NestedStack(stack_resource.StackResource): A Resource representing a child stack to allow composition of templates. ''' - properties_schema = {PROP_TEMPLATE_URL: {'Type': 'String', - 'Required': True}, - PROP_TIMEOUT_MINS: {'Type': 'Number'}, - PROP_PARAMETERS: {'Type': 'Map'}} + properties_schema = { + PROP_TEMPLATE_URL: { + 'Type': 'String', + 'Required': True, + 'Description': _('The URL of a template that specifies the stack' + ' to be created as a resource.')}, + PROP_TIMEOUT_MINS: { + 'Type': 'Number', + 'Description': _('The length of time, in minutes, to wait for the' + ' nested stack creation.')}, + PROP_PARAMETERS: { + 'Type': 'Map', + 'Description': _('The set of parameters passed to this nested' + ' stack.')}} update_allowed_keys = ('Properties',) update_allowed_properties = (PROP_TEMPLATE_URL, PROP_TIMEOUT_MINS, -- 2.45.2