Add note to schema for bigquery table docs (#2895)

Merged PR #2895.
GoogleCloudPlatform · Dec 30, 2019 · 52f4ca1 · 52f4ca1
1 parent aed821e
commit 52f4ca1
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/build/terraform b/build/terraform
diff --git a/build/terraform-beta b/build/terraform-beta
diff --git a/third_party/terraform/website/docs/r/bigquery_table.html.markdown b/third_party/terraform/website/docs/r/bigquery_table.html.markdown
@@ -117,6 +117,12 @@ The following arguments are supported:
     Bigtable, Cloud Datastore backups, and Avro formats when using
     external tables. For more information see the
     [BigQuery API documentation](https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#resource).
+    ~>**NOTE**: Because this field expects a JSON string, any changes to the
+    string will create a diff, even if the JSON itself hasn't changed.
+    If the API returns a different value for the same schema, e.g. it
+    switched the order of values or replaced `STRUCT` field type with `RECORD`
+    field type, we currently cannot suppress the recurring diff this causes.
+    As a workaround, we recommend using the schema as returned by the API.
 
 * `time_partitioning` - (Optional) If specified, configures time-based
     partitioning for this table. Structure is documented below.