docs: add support for description in all field of the schemas (#3273)

* feat: add description of webhosting

* docs(object): add description for schema fields

* docs: add description in schema

* docs: add description for domain

* docs: add support for description in lb schema

* docs: add support for description in instance schema

* docs: add support for description in all field of the schemas

* Fix linter

* Fix linter

Author: remyleone

.github/workflows/tfproviderlint.yml

@@ -21,6 +21,8 @@ jobs:
         run: go install github.com/bflad/tfproviderlint/cmd/tfproviderlint
       - name: Run tfproviderlint
         run: make tfproviderlint
+      - name: Run tfproviderlintx
+        run: make tfproviderlintx
   tfproviderdocs:
     runs-on: ubuntu-latest
     steps:

GNUmakefile

@@ -60,3 +60,6 @@ tfproviderlint:
 
 tfproviderdocs:
 	go tool tfproviderdocs check -provider-name scaleway -enable-contents-check
+
+tfproviderlintx:
+	go tool tfproviderlintx -XR001=false -XS002=false ./...

go.mod

@@ -176,6 +176,7 @@ require (
 tool (
 	github.com/bflad/tfproviderdocs
 	github.com/bflad/tfproviderlint/cmd/tfproviderlint
+	github.com/bflad/tfproviderlint/cmd/tfproviderlintx
 	github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs
 	github.com/katbyte/terrafmt
 )

internal/services/baremetal/server.go

@@ -185,8 +185,9 @@ If this behaviour is wanted, please set 'reinstall_on_ssh_key_changes' argument
 				Elem:        ResourceServerIP(),
 			},
 			"domain": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Description: "Domain associated with the server",
+				Computed:    true,
 			},
 			"options": {
 				Type:        schema.TypeSet,

internal/services/billing/consumption_data_source.go

@@ -20,8 +20,9 @@ func DataSourceConsumptions() *schema.Resource {
 			"organization_id": account.OrganizationIDSchema(),
 			"project_id":      account.ProjectIDSchema(),
 			"consumptions": {
-				Type:     schema.TypeList,
-				Computed: true,
+				Type:        schema.TypeList,
+				Description: "List of the consumptions.",
+				Computed:    true,
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"value": {
@@ -63,8 +64,9 @@ func DataSourceConsumptions() *schema.Resource {
 				},
 			},
 			"updated_at": {
-				Computed: true,
-				Type:     schema.TypeString,
+				Computed:    true,
+				Description: "Date and time when the consumption was updated",
+				Type:        schema.TypeString,
 			},
 		},
 	}

internal/services/billing/invoices_data_source.go

@@ -34,8 +34,9 @@ func DataSourceInvoices() *schema.Resource {
 				Description: "The invoice type. It can either be `periodic` or `purchase`",
 			},
 			"invoices": {
-				Type:     schema.TypeList,
-				Computed: true,
+				Type:        schema.TypeList,
+				Description: "List of invoices",
+				Computed:    true,
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"id": {

internal/services/container/domain.go

@@ -26,7 +26,6 @@ func ResourceDomain() *schema.Resource {
 		Timeouts: &schema.ResourceTimeout{
 			Create:  schema.DefaultTimeout(defaultContainerDomainTimeout),
 			Read:    schema.DefaultTimeout(defaultContainerDomainTimeout),
-			Update:  schema.DefaultTimeout(defaultContainerDomainTimeout),
 			Delete:  schema.DefaultTimeout(defaultContainerDomainTimeout),
 			Default: schema.DefaultTimeout(defaultContainerDomainTimeout),
 		},

internal/services/container/token.go

@@ -28,34 +28,39 @@ func ResourceToken() *schema.Resource {
 		Schema: map[string]*schema.Schema{
 			"container_id": {
 				Type:             schema.TypeString,
+				Description:      "Container ID",
 				ForceNew:         true,
 				Optional:         true,
 				ExactlyOneOf:     []string{"namespace_id"},
 				DiffSuppressFunc: dsf.Locality,
 			},
 			"namespace_id": {
 				Type:             schema.TypeString,
+				Description:      "Namespace ID",
 				ForceNew:         true,
 				Optional:         true,
 				ExactlyOneOf:     []string{"container_id"},
 				DiffSuppressFunc: dsf.Locality,
 			},
 			"description": {
-				Type:     schema.TypeString,
-				Optional: true,
-				ForceNew: true,
+				Type:        schema.TypeString,
+				Description: "Description of the token.",
+				Optional:    true,
+				ForceNew:    true,
 			},
 			"expires_at": {
 				Type:             schema.TypeString,
+				Description:      "Expiration date of the token (TimeRFC3339)",
 				Optional:         true,
 				ForceNew:         true,
 				ValidateDiagFunc: verify.IsDate(),
 				DiffSuppressFunc: dsf.TimeRFC3339,
 			},
 			"token": {
-				Type:      schema.TypeString,
-				Computed:  true,
-				Sensitive: true,
+				Type:        schema.TypeString,
+				Description: "Token",
+				Computed:    true,
+				Sensitive:   true,
 			},
 
 			"region": regional.Schema(),

internal/services/domain/registration.go

@@ -40,9 +40,10 @@ func ResourceRegistration() *schema.Resource {
 				Description: "List of domain names to be managed.",
 			},
 			"duration_in_years": {
-				Type:     schema.TypeInt,
-				Optional: true,
-				Default:  1,
+				Type:        schema.TypeInt,
+				Description: "Duration of the registration period in years.",
+				Optional:    true,
+				Default:     1,
 			},
 			"owner_contact_id": {
 				Type:     schema.TypeString,

internal/services/edgeservices/cache_stage.go

@@ -56,8 +56,9 @@ func ResourceCacheStage() *schema.Resource {
 				Description: "The Time To Live (TTL) in seconds. Defines how long content is cached",
 			},
 			"purge_requests": {
-				Type:     schema.TypeSet,
-				Optional: true,
+				Type:        schema.TypeSet,
+				Description: "Set of purge requests",
+				Optional:    true,
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"pipeline_id": {