Fix region data source documentation

Signed-off-by: Ferran Rodenas <[email protected]>

Author: frodenas

vra/data_source_region.go

@@ -18,10 +18,12 @@ func dataSourceRegion() *schema.Resource {
 
 		Schema: map[string]*schema.Schema{
 			"cloud_account_id": {
-				Type:        schema.TypeString,
-				Optional:    true,
-				Computed:    true,
-				Description: "The id of the cloud account the region belongs to.",
+				Type:          schema.TypeString,
+				Optional:      true,
+				Computed:      true,
+				ConflictsWith: []string{"id", "filter"},
+				Description:   "The id of the cloud account the region belongs to.",
+				RequiredWith:  []string{"region"},
 			},
 			"created_at": {
 				Type:        schema.TypeString,
@@ -34,15 +36,17 @@ func dataSourceRegion() *schema.Resource {
 				Description: "Unique identifier of region on the provider side.",
 			},
 			"filter": {
-				Type:        schema.TypeString,
-				Optional:    true,
-				Description: "Search criteria to narrow down Regions.",
+				Type:          schema.TypeString,
+				ConflictsWith: []string{"cloud_account_id", "id", "region"},
+				Optional:      true,
+				Description:   "Search criteria to narrow down Regions.",
 			},
 			"id": {
-				Type:        schema.TypeString,
-				Optional:    true,
-				Computed:    true,
-				Description: "The id of the region instance.",
+				Type:          schema.TypeString,
+				Optional:      true,
+				Computed:      true,
+				ConflictsWith: []string{"cloud_account_id", "filter", "region"},
+				Description:   "The id of the region instance.",
 			},
 			"name": {
 				Type:        schema.TypeString,
@@ -60,9 +64,11 @@ func dataSourceRegion() *schema.Resource {
 				Description: "Email of the user that owns the entity.",
 			},
 			"region": {
-				Type:        schema.TypeString,
-				Optional:    true,
-				Description: "The specific region associated with the cloud account. On vSphere, this is the external ID.",
+				Type:          schema.TypeString,
+				Optional:      true,
+				ConflictsWith: []string{"id", "filter"},
+				Description:   "The specific region associated with the cloud account. On vSphere, this is the external ID.",
+				RequiredWith:  []string{"cloud_account_id"},
 			},
 			"updated_at": {
 				Type:        schema.TypeString,
@@ -82,7 +88,7 @@ func dataSourceRegionRead(d *schema.ResourceData, meta interface{}) error {
 	id, idOk := d.GetOk("id")
 
 	if !idOk && !cloudAccountIDOk && !regionOk && !filterOk {
-		return fmt.Errorf("one of the following are required: (id, filter, region and cloudAccountId)")
+		return fmt.Errorf("one of the following are required: (`id`, `filter`, or `region` and `cloud_account_id`)")
 	}
 
 	setFields := func(region *models.Region) {

website/docs/d/region.html.markdown

@@ -8,45 +8,59 @@ description: |-
 
 # Data Source: vra\_region
 
-This is an example of how to lookup a region data source.
+This is an example of how to lookup a region data source:
+
+**Region data source by id:**
 
-**Region data source**
 ```hcl
-data "vra_region" "region_1" {
-  cloud_account_id = "cloud_account_id"
-  region           = "us-east-1"
+data "vra_region" "this" {
+  id = var.vra_region_id
 }
 ```
 
+**Region data source by filter:**
+
 ```hcl
-data "vra_region" "eastus" {
-  cloud_account_id = "cloud_account_id"
-  region           = "eastus"
+data "vra_region" "this" {
+  filter = "name eq '${var.vra_region_name}'"
 }
 ```
 
-The region data source supports the following arguments:
+**Region data source by cloud account id and region:**
+
+```hcl
+data "vra_region" "this" {
+  cloud_account_id = var.vra_cloud_account_id
+  region           = var.vra_region_external_id
+}
+```
 
 ## Argument Reference
-* `cloud_account_id` - (Optional) The id of the cloud account this region belongs to. Example: 9e49
 
-* `filter` - (Optional) The id of this resource instance.
+The following arguments are supported:
+
+* `cloud_account_id` - (Optional) The id of the cloud account the region belongs to.
 
-* `id` - (Optional) The id of this resource instance. Example: 9e49
+* `filter` - (Optional) Search criteria to narrow down Regions.
 
-* `region` - (Optional) Name of region on the provider side. In vSphere, the name of the region is different from its id. Example: us-west
+* `id` - (Optional) The id of the region instance.
 
+* `region` - (Optional) The specific region associated with the cloud account. On vSphere, this is the external ID.
+
+-> **Note:** One of `id`, `filter` or` cloud_account_id` and `region` must be specified.
 
 ## Attribute Reference
-* `created_at` - Date when the entity was created. The date is in ISO 8601 and UTC. Example: 2012-09-27
 
-* `external_region_id` - Unique identifier of region on the provider side. Example: us-west
+In addition to all arguments above, the following attributes are exported:
+
+* `created_at` - Date when the entity was created. The date is in ISO 8601 and UTC.
 
-* `name` - Name of region on the provider side. In vSphere, the name of the region is different from its id. Example: us-west
+* `external_region_id` - Unique identifier of region on the provider side.
 
-* `org_id` - The id of the organization this entity belongs to. Example: 9e49
+* `name` - Name of region on the provider side. In vSphere, the name of the region is different from its id.
 
-* `owner` - Email of the user that owns the entity. Example: [email protected]
+* `org_id` - The id of the organization this entity belongs to.
 
-* `updated_at` - Date when the entity was last updated. The date is ISO 8601 and UTC. Example: 2012-09-27
+* `owner` - Email of the user that owns the entity.
 
+* `updated_at` - Date when the entity was last updated. The date is ISO 8601 and UTC.