MMv1 field: changed write_only to write_only_legacy and marked field as deprecated (#15022)

Author: ramonvermeulen

docs/content/reference/field.md

@@ -107,7 +107,7 @@ Example:
 sensitive: true
 ```
 
-### `write_only`
+### `write_only_legacy` (deprecated)
 If true, the field is considered "write-only", which means that its value will
 be obscured in Terraform output as well as not be stored in state. This field is meant to replace `sensitive` as it doesn't store the value in state.
 See [Ephemerality in Resources - Use Write-only arguments](https://developer.hashicorp.com/terraform/language/resources/ephemeral/write-only)
@@ -121,9 +121,11 @@ This field cannot be used in conjuction with `immutable` or `sensitive`.
 Example:
 
 ```yaml
-write_only: true
+write_only_legacy: true
 ```
 
+**Deprecated**: This field is deprecated and will be removed in a future release.
+
 ### `ignore_read`
 If true, the provider sets the field's value in the resource state based only
 on the user's configuration. If false or unset, the provider sets the field's

mmv1/api/resource.go

@@ -617,7 +617,7 @@ func (r Resource) SensitiveProps() []*Type {
 func (r Resource) WriteOnlyProps() []*Type {
 	props := r.AllNestedProperties(r.RootProperties())
 	return google.Select(props, func(p *Type) bool {
-		return p.WriteOnly
+		return p.WriteOnlyLegacy
 	})
 }
 

mmv1/api/type.go

@@ -171,7 +171,9 @@ type Type struct {
 
 	Sensitive bool `yaml:"sensitive,omitempty"` // Adds `Sensitive: true` to the schema
 
-	WriteOnly bool `yaml:"write_only,omitempty"` // Adds `WriteOnly: true` to the schema
+	// TODO: remove this field after all references are migrated
+	// see: https://github.com/GoogleCloudPlatform/magic-modules/pull/14933#pullrequestreview-3166578379
+	WriteOnlyLegacy bool `yaml:"write_only_legacy,omitempty"` // Adds `WriteOnlyLegacy: true` to the schema
 
 	// Does not set this value to the returned API value.  Useful for fields
 	// like secrets where the returned API value is not helpful.
@@ -395,11 +397,11 @@ func (t *Type) Validate(rName string) {
 		log.Fatalf("'default_value' and 'default_from_api' cannot be both set in resource %s", rName)
 	}
 
-	if t.WriteOnly && (t.DefaultFromApi || t.Output) {
+	if t.WriteOnlyLegacy && (t.DefaultFromApi || t.Output) {
 		log.Fatalf("Property %s cannot be write_only and default_from_api or output at the same time in resource %s", t.Name, rName)
 	}
 
-	if t.WriteOnly && t.Sensitive {
+	if t.WriteOnlyLegacy && t.Sensitive {
 		log.Fatalf("Property %s cannot be write_only and sensitive at the same time in resource %s", t.Name, rName)
 	}
 
@@ -750,7 +752,7 @@ func (t Type) WriteOnlyProperties() []*Type {
 		}
 	case t.IsA("NestedObject"):
 		props = google.Select(t.UserProperties(), func(p *Type) bool {
-			return p.WriteOnly
+			return p.WriteOnlyLegacy
 		})
 	case t.IsA("Map"):
 		props = google.Reject(t.ValueType.WriteOnlyProperties(), func(p *Type) bool {
@@ -1224,8 +1226,8 @@ func (t *Type) IsForceNew() bool {
 		return t.Immutable
 	}
 
-	// WriteOnly fields are never immutable
-	if t.WriteOnly {
+	// WriteOnlyLegacy fields are never immutable
+	if t.WriteOnlyLegacy {
 		return false
 	}
 

mmv1/products/bigquerydatatransfer/Config.yaml

@@ -243,7 +243,7 @@ properties:
         type: String
         description: |
           The Secret Access Key of the AWS account transferring data from.
-        write_only: true
+        write_only_legacy: true
         at_least_one_of:
           - 'sensitive_params.0.secretAccessKeyWo'
           - 'sensitive_params.0.secretAccessKey'

mmv1/products/monitoring/UptimeCheckConfig.yaml

@@ -259,7 +259,7 @@ properties:
               - 'password'
             required_with:
               - 'http_check.0.auth_info.0.password_wo_version'
-            write_only: true
+            write_only_legacy: true
           - name: 'passwordWoVersion'
             type: String
             immutable: true

mmv1/products/secretmanager/SecretVersion.yaml

@@ -172,7 +172,7 @@ properties:
           - 'SecretDataWoVersion'
         conflicts:
           - 'payload.0.secretData'
-        write_only: true
+        write_only_legacy: true
       - name: 'SecretDataWoVersion'
         type: Integer
         default_value: 0

mmv1/templates/terraform/custom_flatten/dataplex_entry_aspects.go.tmpl

@@ -15,7 +15,7 @@ func flatten{{$.GetPrefix}}{{$.TitlelizeProperty}}(v interface{}, d *schema.Reso
     transformed = append(transformed, map[string]interface{}{
 
   {{- range $prop := $.ItemType.UserProperties }}
-    {{- if not (or $prop.IgnoreRead $prop.WriteOnly) }}
+    {{- if not (or $prop.IgnoreRead $prop.WriteOnlyLegacy) }}
       "{{ underscore $prop.Name }}": flatten{{$.GetPrefix}}{{$.TitlelizeProperty}}{{$prop.TitlelizeProperty}}(original["{{ $prop.ApiName }}"], d, config),
     {{- end }}
   {{- end }}

mmv1/templates/terraform/flatten_property_method.go.tmpl

@@ -13,7 +13,7 @@
   See the License for the specific language governing permissions and
   limitations under the License. */ -}}
 {{- define "flattenPropertyMethod" }}
-{{- if $.WriteOnly }}
+{{- if $.WriteOnlyLegacy }}
 {{- else if and $.CustomFlatten (not $.ShouldIgnoreCustomFlatten) }}
     {{- $.CustomTemplate $.CustomFlatten false -}}
 {{- else -}}
@@ -34,7 +34,7 @@ func flatten{{$.GetPrefix}}{{$.TitlelizeProperty}}(v interface{}, d *schema.Reso
     {{- end }}
   transformed := make(map[string]interface{})
     {{- range $prop := $.UserProperties }}
-      {{- if $prop.WriteOnly }}
+      {{- if $prop.WriteOnlyLegacy }}
       {{- else if $prop.FlattenObject }}
     if {{ $prop.ApiName }} := flatten{{$.GetPrefix}}{{$.TitlelizeProperty}}{{$prop.TitlelizeProperty}}(original["{{ $prop.ApiName }}"], d, config); {{ $prop.ApiName }} != nil {
       obj := {{ $prop.ApiName }}.([]interface{})[0]
@@ -80,7 +80,7 @@ func flatten{{$.GetPrefix}}{{$.TitlelizeProperty}}(v interface{}, d *schema.Reso
   {{- end }}
 
   {{- range $prop := $.ItemType.UserProperties }}
-    {{- if not (or $prop.IgnoreRead $prop.WriteOnly) }}
+    {{- if not (or $prop.IgnoreRead $prop.WriteOnlyLegacy) }}
       "{{ underscore $prop.Name }}": flatten{{$.GetPrefix}}{{$.TitlelizeProperty}}{{$prop.TitlelizeProperty}}(original["{{ $prop.ApiName }}"], d, config),
     {{- end }}
   {{- end }}

mmv1/templates/terraform/nested_property_write_only_documentation.html.markdown.tmpl

@@ -3,7 +3,7 @@
 {{ "" }}
   {{- if $.NestedProperties }}
     {{- range $np := $.NestedProperties }}
-      {{- if $np.WriteOnly }}
+      {{- if $np.WriteOnlyLegacy }}
 {{- trimTemplate "property_documentation.html.markdown.tmpl" $np -}}
       {{- end -}}
     {{- end -}}

mmv1/templates/terraform/property_documentation.html.markdown.tmpl

@@ -36,7 +36,7 @@
   {{- if $.Sensitive }}
   **Note**: This property is sensitive and will not be displayed in the plan.
   {{- end }}
-  {{- if $.WriteOnly }}
+  {{- if $.WriteOnlyLegacy }}
   **Note**: This property is write-only and will not be read from the API.
   {{- end }}
   {{- if and (not $.FlattenObject) $.NestedProperties }}