docs(object): add description for schema fields

Author: remyleone

internal/services/object/bucket.go

@@ -77,34 +77,40 @@ func ResourceBucket() *schema.Resource {
 				Computed:    true,
 			},
 			"cors_rule": {
-				Type:     schema.TypeList,
-				Optional: true,
-				Computed: true,
+				Type:        schema.TypeList,
+				Description: "List of CORS rules",
+				Optional:    true,
+				Computed:    true,
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"allowed_headers": {
-							Type:     schema.TypeList,
-							Optional: true,
-							Elem:     &schema.Schema{Type: schema.TypeString},
+							Type:        schema.TypeList,
+							Description: "Allowed headers in the CORS rule",
+							Optional:    true,
+							Elem:        &schema.Schema{Type: schema.TypeString},
 						},
 						"allowed_methods": {
-							Type:     schema.TypeList,
-							Required: true,
-							Elem:     &schema.Schema{Type: schema.TypeString},
+							Type:        schema.TypeList,
+							Description: "Allowed HTTP methods allowed in the CORS rule",
+							Required:    true,
+							Elem:        &schema.Schema{Type: schema.TypeString},
 						},
 						"allowed_origins": {
-							Type:     schema.TypeList,
-							Required: true,
-							Elem:     &schema.Schema{Type: schema.TypeString},
+							Type:        schema.TypeList,
+							Description: "Allowed origins allowed in the CORS rule",
+							Required:    true,
+							Elem:        &schema.Schema{Type: schema.TypeString},
 						},
 						"expose_headers": {
-							Type:     schema.TypeList,
-							Optional: true,
-							Elem:     &schema.Schema{Type: schema.TypeString},
+							Type:        schema.TypeList,
+							Description: "Exposed headers in the CORS rule",
+							Optional:    true,
+							Elem:        &schema.Schema{Type: schema.TypeString},
 						},
 						"max_age_seconds": {
-							Type:     schema.TypeInt,
-							Optional: true,
+							Type:        schema.TypeInt,
+							Description: "Max age of the CORS rule",
+							Optional:    true,
 						},
 					},
 				},

internal/services/object/bucket_acl.go

@@ -49,8 +49,9 @@ func ResourceBucketACL() *schema.Resource {
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"grant": {
-							Type:     schema.TypeSet,
-							Optional: true,
+							Type:        schema.TypeSet,
+							Description: "Grant",
+							Optional:    true,
 							Elem: &schema.Resource{
 								Schema: map[string]*schema.Schema{
 									"grantee": {
@@ -61,8 +62,9 @@ func ResourceBucketACL() *schema.Resource {
 										Elem: &schema.Resource{
 											Schema: map[string]*schema.Schema{
 												"display_name": {
-													Type:     schema.TypeString,
-													Computed: true,
+													Type:        schema.TypeString,
+													Description: "Display name of the grantee to grant access to.",
+													Computed:    true,
 												},
 												"uri": {
 													Type:        schema.TypeString,

internal/services/object/bucket_lock_configuration.go

@@ -44,10 +44,11 @@ func ResourceLockConfiguration() *schema.Resource {
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"default_retention": {
-							Type:     schema.TypeList,
-							Required: true,
-							MinItems: 1,
-							MaxItems: 1,
+							Type:        schema.TypeList,
+							Description: "Default retention.",
+							Required:    true,
+							MinItems:    1,
+							MaxItems:    1,
 							Elem: &schema.Resource{
 								Schema: map[string]*schema.Schema{
 									"mode": {

internal/services/object/bucket_website_configuration.go

@@ -44,8 +44,9 @@ func ResourceBucketWebsiteConfiguration() *schema.Resource {
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"suffix": {
-							Type:     schema.TypeString,
-							Required: true,
+							Type:        schema.TypeString,
+							Description: "Suffix that will be added to the index.",
+							Required:    true,
 						},
 					},
 				},
@@ -58,8 +59,9 @@ func ResourceBucketWebsiteConfiguration() *schema.Resource {
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"key": {
-							Type:     schema.TypeString,
-							Required: true,
+							Type:        schema.TypeString,
+							Description: "Key for the object to use as an error document.",
+							Required:    true,
 						},
 					},
 				},