-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Remove internal fields from monitoring uptime check #1974
Remove internal fields from monitoring uptime check #1974
Conversation
Hi! I'm the modular magician, I work on Magic Modules. Pull request statusesNo diff detected in Ansible. New Pull RequestsI built this PR into one or more new PRs on other repositories, and when those are closed, this PR will also be merged and closed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's better to add deprecated
to the fields in the API.yaml. As of right now the rest API docs and the discovery docs still have them listed. I think with the addition of tooling around generating the api.yaml and/or linting it I would prefer to leave them in the file rather than adding custom code to Terraform to remove them.
templates/terraform/extra_schema_entry/monitoring_uptime_check_config_internal.go.erb
Show resolved
Hide resolved
I disagree- these fields never existed outside of the internal/ possibly the EAP API and were never intended to be surfaced to users. If a user ever specified them, they never worked. The deprecated message passed over in the REST reference does not refer to the fields being deprecated at GA, it refers to them being deprecated in a private API version. Also If/when we generate API definitions, we shouldn't include deprecated fields. |
Ideal scenario is definitely not to add deprecated fields to the api.yaml in the first place. But right now there is no way to identify from the discovery docs that these fields are deprecated, so any tooling in the future will lose the context and potentially re-add them. Adding a deprecation flag in the yaml is effectively what the UI has done with the 'warning' in the rest documentation. I think it's a reasonable pattern to include a deprecation flag for fields that were once part of an API and now are no longer. |
These were never part of the API though, and were erroneously published as part of the REST reference. I think we should handle deprecated fields with |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fair enough
Hi! I'm the modular magician, I work on Magic Modules. Pull request statusesterraform-provider-google-beta already has an open PR. New Pull RequestsI didn't open any new pull requests because of this PR. |
Tracked submodules are build/terraform-beta build/terraform-mapper build/terraform build/ansible build/inspec.
We never tested these fields, and turns out they don't work. They were erroneously published in the API (http://b/122540324)
Release Note for Downstream PRs (will be copied)