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

Fix: Clarify usage of schema in Table #8661

Merged

Conversation

nevzheng
Copy link
Contributor

@nevzheng nevzheng commented Aug 16, 2023

Our users highlighted unclear documentation, which I have clarified in this PR.

Fixes: hashicorp/terraform-provider-google#15377

If this PR is for Terraform, I acknowledge that I have:

  • Searched through the issue tracker for an open issue that this either resolves or contributes to, commented on it to claim it, and written "fixes {url}" or "part of {url}" in this PR description. If there were no relevant open issues, I opened one and commented that I would like to work on it (not necessary for very small changes).
  • Ensured that all new fields I added that can be set by a user appear in at least one example (for generated resources) or third_party test (for handwritten resources or update tests).
  • Generated Terraform providers, and ran make test and make lint in the generated providers to ensure it passes unit and linter tests.
  • Ran relevant acceptance tests using my own Google Cloud project and credentials (If the acceptance tests do not yet pass or you are unable to run them, please let your reviewer know).
  • Read Write release notes before writing my release note below.

Release Note Template for Downstream PRs (will be copied)

bigquery: Clarify usage of `schema` in `google_bigquery_table`

@modular-magician
Copy link
Collaborator

Hello! I am a robot. It looks like you are a: Community Contributor Googler Core Contributor. Tests will run automatically.

@melinath, a repository maintainer, has been assigned to review your changes. If you have not received review feedback within 2 business days, please leave a comment on this PR asking them to take a look.

You can help make sure that review is quick by doing a self-review and by running impacted tests locally.

@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 1 file changed, 18 insertions(+), 2 deletions(-))
Terraform Beta: Diff ( 1 file changed, 18 insertions(+), 2 deletions(-))

@nevzheng nevzheng requested a review from melinath August 16, 2023 16:18
@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 1 file changed, 18 insertions(+), 2 deletions(-))
Terraform Beta: Diff ( 1 file changed, 18 insertions(+), 2 deletions(-))

Copy link
Member

@melinath melinath left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also adjust the surrounding lines - unfortunately GitHub does not support multi-line suggestions.

@melinath melinath merged commit 9f460c6 into GoogleCloudPlatform:main Aug 16, 2023
8 checks passed
@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 1 file changed, 17 insertions(+), 7 deletions(-))
Terraform Beta: Diff ( 1 file changed, 17 insertions(+), 7 deletions(-))

ron-gal pushed a commit to ron-gal/magic-modules that referenced this pull request Aug 17, 2023
* Fix: Clarify usage of `schema` in Table

* Update mmv1/third_party/terraform/website/docs/r/bigquery_table.html.markdown

Co-authored-by: Stephen Lewis (Burrows) <[email protected]>

* Update mmv1/third_party/terraform/website/docs/r/bigquery_table.html.markdown

Co-authored-by: Stephen Lewis (Burrows) <[email protected]>

* Update mmv1/third_party/terraform/website/docs/r/bigquery_table.html.markdown

Co-authored-by: Stephen Lewis (Burrows) <[email protected]>

* fix: delete extra info

* add: anchor for `schema`

* fix: follow existing anchor convention

---------

Co-authored-by: Stephen Lewis (Burrows) <[email protected]>
@nevzheng nevzheng deleted the clarify-bq-table-schema-usage branch August 17, 2023 15:11
joelkattapuram pushed a commit to joelkattapuram/magic-modules that referenced this pull request Sep 20, 2023
* Fix: Clarify usage of `schema` in Table

* Update mmv1/third_party/terraform/website/docs/r/bigquery_table.html.markdown

Co-authored-by: Stephen Lewis (Burrows) <[email protected]>

* Update mmv1/third_party/terraform/website/docs/r/bigquery_table.html.markdown

Co-authored-by: Stephen Lewis (Burrows) <[email protected]>

* Update mmv1/third_party/terraform/website/docs/r/bigquery_table.html.markdown

Co-authored-by: Stephen Lewis (Burrows) <[email protected]>

* fix: delete extra info

* add: anchor for `schema`

* fix: follow existing anchor convention

---------

Co-authored-by: Stephen Lewis (Burrows) <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

google_bigquery_table expects schema at the top-level rather than in external_data_configuration
3 participants