Removed unused key_description and value_type.name properties usage and added validation to prevent additions (GoogleCloudPlatform#16179)

Author: melinath

docs/content/develop/add-fields.md

@@ -165,16 +165,12 @@ Replace `String` in the field type with one of the following options:
     description: |
       MULTILINE_FIELD_DESCRIPTION
     key_name: 'key_name'
-    key_description: |
-      MULTILINE_KEY_FIELD_DESCRIPTION
   # Map of primitive values
     value_type:
-      name: mapIntegerName
       type: Integer
 
   # Map of complex values
     value_type:
-      name: mapObjectName
       type: NestedObject
       properties:
       - name: 'FIELD_NAME'
@@ -185,7 +181,7 @@ Replace `String` in the field type with one of the following options:
 
 This type is used for general-case string -> non-string type mappings, use "KeyValuePairs" for string -> string mappings. Complex maps can't be represented natively in Terraform, and this type is transformed into an associative array (TypeSet) with the key merged into the object alongside other top-level fields.
 
-For `key_name` and `key_description`, provide a domain-appropriate name and description. For example, a map that references a specific type of resource would generally use the singular resource kind as the key name (such as "topic" for PubSub Topic) and a descriptor of the expected format depending on the context (such as resourceId vs full resource name).
+For `key_name`, provide a domain-appropriate field name. For example, a map that references a specific type of resource would generally use the singular resource kind as the key name (such as "topic" for PubSub Topic).
 
 {{< /tab >}}
 {{< /tabs >}}

mmv1/api/type.go

@@ -240,7 +240,7 @@ type Type struct {
 	// The name of the key. Used in the Terraform schema as a field name.
 	KeyName string `yaml:"key_name,omitempty"`
 
-	// A description of the key's format. Used in Terraform to describe
+	// Deprecated. A description of the key's format. Used in Terraform to describe
 	// the field in documentation.
 	KeyDescription string `yaml:"key_description,omitempty"`
 
@@ -467,7 +467,9 @@ func (t *Type) SetDefault(r *Resource) {
 		if t.ValueType != nil {
 			t.ValueType.ParentName = t.Name
 			t.ValueType.ParentMetadata = t
-			t.ValueType.SetDefault(r) // Recurse
+			oldName := t.ValueType.Name
+			t.ValueType.SetDefault(r)  // Recurse
+			t.ValueType.Name = oldName // unset name if it was previously unset
 		}
 	case t.IsA("NestedObject"):
 		for _, p := range t.Properties {
@@ -498,13 +500,25 @@ func (t *Type) Validate(rName string) {
 		log.Fatalf("Property %s cannot be write_only and sensitive at the same time in resource %s", t.Name, rName)
 	}
 
+	if t.KeyDescription != "" {
+		log.Fatalf("Property %s.key_description can't be set in resource %s; it's deprecated", t.Name, rName)
+	}
+
 	t.validateLabelsField()
 
 	switch {
 	case t.IsA("Array"):
 		t.ItemType.Validate(rName)
 	case t.IsA("Map"):
+		// ValueType.Name should be empty (because it's unused) but we require types to have names in all other cases.
+		// This logic allows both to be validated.
+		oldName := t.ValueType.Name
+		t.ValueType.Name = "any_value"
 		t.ValueType.Validate(rName)
+		t.ValueType.Name = oldName
+		if t.ValueType.Name != "" {
+			log.Fatalf("Property %s.name can't be set in resource %s", t.Name, rName)
+		}
 	case t.IsA("NestedObject"):
 		for _, p := range t.Properties {
 			p.Validate(rName)
@@ -1310,7 +1324,6 @@ func (t Type) fieldMinVersion() string {
 //   func (t *Type) validate
 //     super
 //     check :key_name, type: ::String, required: true
-//     check :key_description, type: ::String
 //     check :value_type, type: Api::Type::NestedObject, required: true
 //     raise "Invalid type //{@value_type}" unless type?(@value_type)
 //   end

mmv1/openapi_generate/parser.go

@@ -509,7 +509,6 @@ func WriteObject(name string, obj *openapi3.SchemaRef, objType openapi3.Types, u
 			field.Type = "Map"
 			field.KeyName = "TODO: CHANGEME"
 			var valueType api.Type
-			valueType.Name = "TODO: CHANGEME"
 			valueType.Type = "NestedObject"
 			valueType.Properties = buildProperties(obj.Value.AdditionalProperties.Schema.Value.Properties, obj.Value.AdditionalProperties.Schema.Value.Required)
 			field.ValueType = &valueType

mmv1/products/apigee/SecurityProfileV2.yaml

@@ -77,7 +77,6 @@ properties:
     required: true
     key_name: 'assessment'
     value_type:
-      name: profileAssessmentConfig
       type: NestedObject
       properties:
         - name: 'weight'

mmv1/products/appengine/FlexibleAppVersion.yaml

@@ -551,10 +551,7 @@ properties:
           - 'deployment.0.files'
           - 'deployment.0.container'
         key_name: 'name'
-        key_description: |
-          name of file
         value_type:
-          name: files
           type: NestedObject
           properties:
             - name: 'sha1Sum'

mmv1/products/appengine/StandardAppVersion.yaml

@@ -285,10 +285,7 @@ properties:
           - 'deployment.0.zip'
           - 'deployment.0.files'
         key_name: 'name'
-        key_description: |
-          name of file
         value_type:
-          name: files
           type: NestedObject
           properties:
             - name: 'sha1Sum'

mmv1/products/artifactregistry/Repository.yaml

@@ -376,11 +376,8 @@ properties:
       Map keys are policy IDs supplied by users during policy creation. They must
       unique within a repository and be under 128 characters in length.
     key_name: 'id'
-    key_description: |-
-      The policy ID. Must be unique within a repository.
     set_hash_func: 'mapHashID'
     value_type:
-      name: cleanupPolicies
       type: NestedObject
       properties:
         - name: 'action'

mmv1/products/backupdr/RestoreWorkload.yaml

@@ -370,7 +370,6 @@ properties:
         type: Map
         key_name: key
         value_type:
-          name: value
           type: NestedObject
           properties:
             - name: 'value'
@@ -527,7 +526,6 @@ properties:
             type: Map
             key_name: key
             value_type:
-              name: value
               type: NestedObject
               properties:
                 - name: 'value'
@@ -751,7 +749,6 @@ properties:
         type: Map
         key_name: key
         value_type:
-          name: value
           type: NestedObject
           properties:
             - name: 'value'
@@ -761,7 +758,6 @@ properties:
         type: Map
         key_name: key
         value_type:
-          name: value
           type: NestedObject
           properties:
             - name: 'value'

mmv1/products/beyondcorp/SecurityGateway.yaml

@@ -111,10 +111,8 @@ properties:
       Optional. Map of Hubs that represents regional data path deployment with GCP region
       as a key.
     key_name: region
-    key_description: The region to deploy the hub in.
     set_hash_func: 'beyondcorpSecurityGatewayHubsHash'
     value_type:
-      name: Hub
       type: NestedObject
       properties:
         - name: internetGateway

mmv1/products/bigqueryanalyticshub/DataExchangeSubscription.yaml

@@ -207,9 +207,7 @@ properties:
       e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset
       For Data Exchange subscriptions, this map may contain multiple entries if the Data Exchange has multiple listings.
     key_name: resource_name
-    key_description: The associated linked resource
     value_type:
-      name: linked_resource
       type: NestedObject
       properties:
         - name: 'listing'