Add descriptions to schemas by hand to MM resources (#4418) (#2939)

Co-authored-by: upodroid <[email protected]>
Signed-off-by: Modular Magician <[email protected]>

Co-authored-by: upodroid <[email protected]>

Author: modular-magician

.changelog/4418.txt

@@ -0,0 +1,9 @@
+```release-note:deprecation
+pubsub: deprecated `path` field in `google_pubsub_subscription` resource as it is identical value to `id` field.
+```
+```release-note:deprecation
+kms: deprecated `self_link` field in `google_kms_keyring` and `google_kms_cryptokey` resource as it is identical value to `id` field.
+```
+```release-note:deprecation
+compute: deprecated `source_disk_url` field in `google_compute_snapshot`.
+```

google-beta/resource_api_gateway_api_config.go

@@ -145,6 +145,7 @@ If not specified, backend authentication will be set to use OIDC authentication
 				Computed:      true,
 				ForceNew:      true,
 				ConflictsWith: []string{"api_config_id"},
+				Description:   `Creates a unique name beginning with the specified prefix. If this and api_config_id are unspecified, a random value is chosen for the name.`,
 			},
 			"project": {
 				Type:     schema.TypeString,

google-beta/resource_compute_region_ssl_certificate.go

@@ -106,6 +106,7 @@ If it is not provided, the provider region is used.`,
 				Computed:      true,
 				ForceNew:      true,
 				ConflictsWith: []string{"name"},
+				Description:   "Creates a unique name beginning with the specified prefix. Conflicts with name.",
 				ValidateFunc: func(v interface{}, k string) (ws []string, errors []error) {
 					// https://cloud.google.com/compute/docs/reference/latest/sslCertificates#resource
 					// uuid is 26 characters, limit the prefix to 37.

google-beta/resource_compute_route.go

@@ -158,9 +158,10 @@ Default value is 1000. Valid range is 0 through 65535.`,
 				Description: `URL to a Network that should handle matching packets.`,
 			},
 			"next_hop_instance_zone": {
-				Type:     schema.TypeString,
-				Optional: true,
-				ForceNew: true,
+				Type:        schema.TypeString,
+				Optional:    true,
+				ForceNew:    true,
+				Description: "The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.",
 			},
 			"project": {
 				Type:     schema.TypeString,

google-beta/resource_compute_snapshot.go

@@ -200,8 +200,9 @@ storage, this number is expected to change with snapshot
 creation/deletion.`,
 			},
 			"source_disk_link": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:       schema.TypeString,
+				Computed:   true,
+				Deprecated: "Deprecated in favor of source_disk, which contains a compatible value. This field will be removed in the next major release of the provider.",
 			},
 			"project": {
 				Type:     schema.TypeString,

google-beta/resource_compute_ssl_certificate.go

@@ -97,6 +97,7 @@ These are in the same namespace as the managed SSL certificates.`,
 				Computed:      true,
 				ForceNew:      true,
 				ConflictsWith: []string{"name"},
+				Description:   "Creates a unique name beginning with the specified prefix. Conflicts with name.",
 				ValidateFunc: func(v interface{}, k string) (ws []string, errors []error) {
 					// https://cloud.google.com/compute/docs/reference/latest/sslCertificates#resource
 					// uuid is 26 characters, limit the prefix to 37.

google-beta/resource_kms_crypto_key.go

@@ -127,8 +127,10 @@ See the [algorithm reference](https://cloud.google.com/kms/docs/reference/rest/v
 				},
 			},
 			"self_link": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
+				Deprecated:  "Deprecated in favor of id, which contains an identical value. This field will be removed in the next major release of the provider.",
+				Description: "The self link of the created KeyRing in the format projects/{project}/locations/{location}/keyRings/{name}.",
 			},
 		},
 		UseJSONNumber: true,

google-beta/resource_kms_key_ring.go

@@ -53,8 +53,10 @@ A full list of valid locations can be found by running 'gcloud kms locations lis
 				Description: `The resource name for the KeyRing.`,
 			},
 			"self_link": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
+				Deprecated:  "Deprecated in favor of id, which contains an identical value. This field will be removed in the next major release of the provider.",
+				Description: "The self link of the created KeyRing in the format projects/{project}/locations/{location}/keyRings/{name}.",
 			},
 			"project": {
 				Type:     schema.TypeString,

google-beta/resource_pubsub_subscription.go

@@ -318,8 +318,10 @@ A duration in seconds with up to nine fractional digits, terminated by 's'. Exam
 				},
 			},
 			"path": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
+				Deprecated:  "Deprecated in favor of id, which contains an identical value. This field will be removed in the next major release of the provider.",
+				Description: " Path of the subscription in the format projects/{project}/subscriptions/{name}",
 			},
 			"project": {
 				Type:     schema.TypeString,

google-beta/resource_redis_instance.go

@@ -198,9 +198,10 @@ checked before each import/export operation.`,
 				Description: `The port number of the exposed Redis endpoint.`,
 			},
 			"auth_string": {
-				Type:     schema.TypeString,
-				Optional: true,
-				Computed: true,
+				Type:        schema.TypeString,
+				Description: "AUTH String set on the instance. This field will only be populated if auth_enabled is true.",
+				Optional:    true,
+				Computed:    true,
 			},
 			"project": {
 				Type:     schema.TypeString,