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 #4418

Merged
merged 13 commits into from
Feb 8, 2021
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
2 changes: 1 addition & 1 deletion mmv1/products/kms/terraform.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ overrides: !ruby/object:Overrides::ResourceOverrides
skip_test: true
docs: !ruby/object:Provider::Terraform::Docs
attributes: |
* `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.
properties:
createTime: !ruby/object:Overrides::Terraform::PropertyOverride
exclude: true
Expand Down
2 changes: 1 addition & 1 deletion mmv1/products/pubsub/terraform.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ overrides: !ruby/object:Overrides::ResourceOverrides
subscription_name: "example-subscription"
docs: !ruby/object:Provider::Terraform::Docs
attributes: |
* `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.
note: |
You can retrieve the email of the Google Managed Pub/Sub Service Account used for forwarding
by using the `google_project_service_identity` resource.
Expand Down
1 change: 1 addition & 0 deletions mmv1/templates/terraform/extra_schema_entry/api_config.erb
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@
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.`,
},
2 changes: 2 additions & 0 deletions mmv1/templates/terraform/extra_schema_entry/kms_self_link.erb
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"self_link": &schema.Schema{
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}.",
},
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"path": &schema.Schema{
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}",
},
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
"auth_string": {
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,
},
1 change: 1 addition & 0 deletions mmv1/templates/terraform/extra_schema_entry/route.erb
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
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.",
},
1 change: 1 addition & 0 deletions mmv1/templates/terraform/extra_schema_entry/snapshot.erb
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@
"source_disk_link": {
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.",
},
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
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