From 50748c7b23629dc05accc3938aa3a975b372b179 Mon Sep 17 00:00:00 2001
From: Jeff Peeler <jpeeler@redhat.com>
Date: Wed, 26 Feb 2014 15:55:50 -0500
Subject: [PATCH] Document schema properties for Neutron subnet resource

Change-Id: If88f626cb0a94f3700c713b915f6ebb5448dd97e
Closes-Bug: #1224178
---
 heat/engine/resources/neutron/subnet.py | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/heat/engine/resources/neutron/subnet.py b/heat/engine/resources/neutron/subnet.py
index 16c2367077..87ce9e0ffa 100644
--- a/heat/engine/resources/neutron/subnet.py
+++ b/heat/engine/resources/neutron/subnet.py
@@ -46,23 +46,28 @@ class Subnet(neutron.NeutronResource):
     properties_schema = {
         NETWORK_ID: properties.Schema(
             properties.Schema.STRING,
+            _('The ID of the attached network.'),
             required=True
         ),
         CIDR: properties.Schema(
             properties.Schema.STRING,
+            _('The CIDR.'),
             required=True
         ),
         VALUE_SPECS: properties.Schema(
             properties.Schema.MAP,
+            _('Extra parameters to include in the creation request.'),
             default={},
             update_allowed=True
         ),
         NAME: properties.Schema(
             properties.Schema.STRING,
+            _('The name of the subnet.'),
             update_allowed=True
         ),
         IP_VERSION: properties.Schema(
             properties.Schema.INTEGER,
+            _('The IP version, which is 4 or 6.'),
             default=4,
             constraints=[
                 constraints.AllowedValues([4, 6]),
@@ -70,20 +75,24 @@ class Subnet(neutron.NeutronResource):
         ),
         DNS_NAMESERVERS: properties.Schema(
             properties.Schema.LIST,
+            _('A specified set of DNS name servers to be used.'),
             default=[],
             update_allowed=True
         ),
         GATEWAY_IP: properties.Schema(
             properties.Schema.STRING,
+            _('The gateway IP address.'),
             update_allowed=True
         ),
         ENABLE_DHCP: properties.Schema(
             properties.Schema.BOOLEAN,
+            _('Set to true if DHCP is enabled and false if DHCP is disabled.'),
             default=True,
             update_allowed=True
         ),
         ALLOCATION_POOLS: properties.Schema(
             properties.Schema.LIST,
+            _('The start and end addresses for the allocation pools.'),
             schema=properties.Schema(
                 properties.Schema.MAP,
                 schema={
@@ -99,7 +108,9 @@ class Subnet(neutron.NeutronResource):
             )
         ),
         TENANT_ID: properties.Schema(
-            properties.Schema.STRING
+            properties.Schema.STRING,
+            _('The ID of the tenant who owns the network. Only administrative'
+              ' users can specify a tenant ID other than their own.')
         ),
     }