chore: update content type schema docs

labd · Jan 17, 2023 · 7d174ee · 7d174ee
1 parent 84f47f0
commit 7d174ee
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 7 deletions.
diff --git a/amplience/resource_content_type_schema.go b/amplience/resource_content_type_schema.go
@@ -27,14 +27,16 @@ func resourceContentTypeSchema() *schema.Resource {
 		},
 		Schema: map[string]*schema.Schema{
 			"body": {
-				Type:     schema.TypeString,
-				Required: true,
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "JSON definition of the schema",
 			},
 			"schema_id": {
 				Type:             schema.TypeString,
 				Required:         true,
 				ForceNew:         true,
 				ValidateDiagFunc: ValidateDiagWrapper(validation.StringDoesNotContainAny(" ")),
+				Description:      "Unique schema ID",
 			},
 			"validation_level": {
 				Type:     schema.TypeString,
@@ -45,9 +47,10 @@ func resourceContentTypeSchema() *schema.Resource {
 				Computed: true,
 			},
 			"auto_sync": {
-				Type:     schema.TypeBool,
-				Optional: true,
-				Default:  false,
+				Type:        schema.TypeBool,
+				Optional:    true,
+				Default:     false,
+				Description: "Enable if you want content types to be automatically synced when the schema gets updated",
 			},
 		},
 	}

diff --git a/docs/resources/content_type_schema.md b/docs/resources/content_type_schema.md
@@ -63,12 +63,13 @@ resource "amplience_content_type_schema" "tag" {
 
 ### Required
 
-- **body** (String)
-- **schema_id** (String)
+- **body** (String) JSON definition of the schema
+- **schema_id** (String) Unique schema ID
 - **validation_level** (String)
 
 ### Optional
 
+- **auto_sync** (Boolean) Enable if you want content types to be automatically synced when the schema gets updated
 - **id** (String) The ID of this resource.
 
 ### Read-Only