Improve documentation for Pub/Sub Schema updates (#9070) (#6377)

Signed-off-by: Modular Magician <[email protected]>
hashicorp · Sep 25, 2023 · ececd46 · ececd46
1 parent 7552249
commit ececd46
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/.changelog/9070.txt b/.changelog/9070.txt
@@ -0,0 +1,3 @@
+```release-note:none
+
+```
diff --git a/google-beta/services/pubsub/resource_pubsub_schema.go b/google-beta/services/pubsub/resource_pubsub_schema.go
@@ -60,7 +60,11 @@ func ResourcePubsubSchema() *schema.Resource {
 				Optional: true,
 				Description: `The definition of the schema.
 This should contain a string representing the full definition of the schema
-that is a valid schema definition of the type specified in type.`,
+that is a valid schema definition of the type specified in type. Changes
+to the definition commit new [schema revisions](https://cloud.google.com/pubsub/docs/commit-schema-revision).
+A schema can only have up to 20 revisions, so updates that fail with an
+error indicating that the limit has been reached require manually
+[deleting old revisions](https://cloud.google.com/pubsub/docs/delete-schema-revision).`,
 			},
 			"type": {
 				Type:         schema.TypeString,

diff --git a/website/docs/r/pubsub_schema.html.markdown b/website/docs/r/pubsub_schema.html.markdown
@@ -89,7 +89,11 @@ The following arguments are supported:
   (Optional)
   The definition of the schema.
   This should contain a string representing the full definition of the schema
-  that is a valid schema definition of the type specified in type.
+  that is a valid schema definition of the type specified in type. Changes
+  to the definition commit new [schema revisions](https://cloud.google.com/pubsub/docs/commit-schema-revision).
+  A schema can only have up to 20 revisions, so updates that fail with an
+  error indicating that the limit has been reached require manually
+  [deleting old revisions](https://cloud.google.com/pubsub/docs/delete-schema-revision).
 
 * `project` - (Optional) The ID of the project in which the resource belongs.
     If it is not provided, the provider project is used.