Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add descriptions to schemas by hand to MM resources #8410

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .changelog/4418.txt
Original file line number Diff line number Diff line change
@@ -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`.
```
1 change: 1 addition & 0 deletions google/resource_compute_region_ssl_certificate.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
7 changes: 4 additions & 3 deletions google/resource_compute_route.go
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
5 changes: 3 additions & 2 deletions google/resource_compute_snapshot.go
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
1 change: 1 addition & 0 deletions google/resource_compute_ssl_certificate.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 4 additions & 2 deletions google/resource_kms_crypto_key.go
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
6 changes: 4 additions & 2 deletions google/resource_kms_key_ring.go
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
6 changes: 4 additions & 2 deletions google/resource_pubsub_subscription.go
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
7 changes: 4 additions & 3 deletions google/resource_redis_instance.go
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/kms_crypto_key.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ In addition to the arguments listed above, the following computed attributes are
* `id` - an identifier for the resource with format `{{key_ring}}/cryptoKeys/{{name}}`


* `self_link`: The self link of the created CryptoKey. Its format is `{{key_ring}}/cryptoKeys/{{name}}`.
* `self_link`: Deprecated in favor of `id`, which contains an identical value. This field will be removed in the next major release of the provider.

## Timeouts

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/pubsub_subscription.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,7 @@ In addition to the arguments listed above, the following computed attributes are
* `id` - an identifier for the resource with format `projects/{{project}}/subscriptions/{{name}}`


* `path`: Path of the subscription in the format `projects/{project}/subscriptions/{name}`
* `path`: Deprecated in favor of `id`, which contains an identical value. This field will be removed in the next major release of the provider.

## Timeouts

Expand Down