Add descriptions to Terraform schema (GoogleCloudPlatform#2643)

Merged PR GoogleCloudPlatform#2643.
emilymye · Nov 12, 2019 · 03fc72c · 03fc72c
1 parent bf5e882
commit 03fc72c
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 9 deletions.
diff --git a/build/terraform b/build/terraform
diff --git a/build/terraform-beta b/build/terraform-beta
diff --git a/products/compute/api.yaml b/products/compute/api.yaml
@@ -805,7 +805,7 @@ objects:
               - !ruby/object:Api::Type::NestedObject
                 name: 'ttl'
                 description: |
-                  Liftime of the cookie.
+                  Lifetime of the cookie.
                 properties:
                   - !ruby/object:Api::Type::Integer
                     name: 'seconds'
@@ -1471,7 +1471,7 @@ objects:
               - !ruby/object:Api::Type::NestedObject
                 name: 'ttl'
                 description: |
-                  Liftime of the cookie.
+                  Lifetime of the cookie.
                 properties:
                   - !ruby/object:Api::Type::Integer
                     name: 'seconds'
@@ -9167,11 +9167,11 @@ objects:
           - :ACTIVE
           - :BACKUP
         description: |
-          The role of subnetwork. Currenly, this field is only used
-          when purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set
-          to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently
-          being used for Internal HTTP(S) Load Balancing. A BACKUP subnetwork
-          is one that is ready to be promoted to ACTIVE or is currently draining.
+          The role of subnetwork. Currently, this field is only used when
+          purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE
+          or BACKUP. An ACTIVE subnetwork is one that is currently being used
+          for Internal HTTP(S) Load Balancing. A BACKUP subnetwork is one that
+          is ready to be promoted to ACTIVE or is currently draining.
       - !ruby/object:Api::Type::Array
         name: 'secondaryIpRanges'
         description: |

diff --git a/templates/terraform/schema_property.erb b/templates/terraform/schema_property.erb
@@ -64,6 +64,7 @@
 <% unless property.state_func.nil? -%>
 	StateFunc: <%= property.state_func %>,
 <% end -%>
+	Description: `<%= property.description.strip.gsub("`", "'") -%>`,
 <% if property.is_a?(Api::Type::NestedObject) -%>
   MaxItems: 1,
   Elem: &schema.Resource{