Doc string updates for v1.0.0-rc2 (#318)

* Doc string updates * make docs
Twingate · Apr 13, 2023 · 422f0aa · 422f0aa
1 parent 9ee13a4
commit 422f0aa
Show file tree

Hide file tree

Showing 14 changed files with 14 additions and 14 deletions.
diff --git a/docs/data-sources/connector.md b/docs/data-sources/connector.md
@@ -23,7 +23,7 @@ data "twingate_connector" "foo" {
 
 ### Required
 
-- `id` (String) The ID of the Connector. The ID for the Connector must be obtained from the Admin API.
+- `id` (String) The ID of the Connector. The ID for the Connector can be obtained from the Admin API or the URL string in the Admin Console.
 
 ### Read-Only
 

diff --git a/docs/data-sources/group.md b/docs/data-sources/group.md
@@ -23,7 +23,7 @@ data "twingate_group" "foo" {
 
 ### Required
 
-- `id` (String) The ID of the Group. The ID for the Group must be obtained from the Admin API.
+- `id` (String) The ID of the Group. The ID for the Group can be obtained from the Admin API or the URL string in the Admin Console.
 
 ### Read-Only
 

diff --git a/docs/data-sources/resource.md b/docs/data-sources/resource.md
@@ -23,7 +23,7 @@ data "twingate_resource" "foo" {
 
 ### Required
 
-- `id` (String) The ID of the Resource. The ID for the Resource must be obtained from the Admin API.
+- `id` (String) The ID of the Resource. The ID for the Resource can be obtained from the Admin API or the URL string in the Admin Console.
 
 ### Read-Only
 

diff --git a/docs/data-sources/security_policies.md b/docs/data-sources/security_policies.md
@@ -29,7 +29,7 @@ data "twingate_security_policies" "all" {}
 
 Read-Only:
 
-- `id` (String) Return a matching Security Policy by its ID. The ID for the Security Policy must be obtained from the Admin API.
+- `id` (String) Return a matching Security Policy by its ID. The ID for the Security Policy can be obtained from the Admin API or the URL string in the Admin Console.
 - `name` (String) Return a Security Policy that exactly matches this name.
 
 
diff --git a/docs/data-sources/security_policy.md b/docs/data-sources/security_policy.md
@@ -23,7 +23,7 @@ data "twingate_security_policy" "foo" {
 
 ### Optional
 
-- `id` (String) Return a Security Policy by its ID. The ID for the Security Policy must be obtained from the Admin API.
+- `id` (String) Return a Security Policy by its ID. The ID for the Security Policy can be obtained from the Admin API or the URL string in the Admin Console.
 - `name` (String) Return a Security Policy that exactly matches this name.
 
 
diff --git a/docs/data-sources/user.md b/docs/data-sources/user.md
@@ -23,7 +23,7 @@ data "twingate_user" "foo" {
 
 ### Required
 
-- `id` (String) The ID of the User. The ID for the User must be obtained from the Admin API.
+- `id` (String) The ID of the User. The ID for the User can be obtained from the Admin API or the URL string in the Admin Console.
 
 ### Read-Only
 

diff --git a/docs/resources/resource.md b/docs/resources/resource.md
@@ -65,7 +65,7 @@ resource "twingate_resource" "resource" {
 ### Optional
 
 - `access` (Block List, Max: 1) Restrict access to certain groups or service accounts (see [below for nested schema](#nestedblock--access))
-- `alias` (String) Resource alias address
+- `alias` (String) Set a DNS alias address for the Resource. Must be a DNS-valid name string.
 - `is_authoritative` (Boolean) Determines whether assignments in the access block will override any existing assignments. Default is `true`. If set to `false`, assignments made outside of Terraform will be ignored.
 - `is_browser_shortcut_enabled` (Boolean) Controls whether an "Open in Browser" shortcut will be shown for this Resource in the Twingate Client.
 - `is_visible` (Boolean) Controls whether this Resource will be visible in the main Resource list in the Twingate Client.

diff --git a/twingate/internal/provider/datasource/connector.go b/twingate/internal/provider/datasource/connector.go
@@ -43,7 +43,7 @@ func Connector() *schema.Resource {
 			attr.ID: {
 				Type:        schema.TypeString,
 				Required:    true,
-				Description: "The ID of the Connector. The ID for the Connector must be obtained from the Admin API.",
+				Description: "The ID of the Connector. The ID for the Connector can be obtained from the Admin API or the URL string in the Admin Console.",
 			},
 			// computed
 			attr.Name: {

diff --git a/twingate/internal/provider/datasource/group.go b/twingate/internal/provider/datasource/group.go
@@ -47,7 +47,7 @@ func Group() *schema.Resource {
 			attr.ID: {
 				Type:        schema.TypeString,
 				Required:    true,
-				Description: "The ID of the Group. The ID for the Group must be obtained from the Admin API.",
+				Description: "The ID of the Group. The ID for the Group can be obtained from the Admin API or the URL string in the Admin Console.",
 			},
 			attr.Name: {
 				Type:        schema.TypeString,

diff --git a/twingate/internal/provider/datasource/resource.go b/twingate/internal/provider/datasource/resource.go
@@ -67,7 +67,7 @@ func Resource() *schema.Resource { //nolint:funlen
 			attr.ID: {
 				Type:        schema.TypeString,
 				Required:    true,
-				Description: "The ID of the Resource. The ID for the Resource must be obtained from the Admin API.",
+				Description: "The ID of the Resource. The ID for the Resource can be obtained from the Admin API or the URL string in the Admin Console.",
 			},
 			// computed
 			attr.Name: {

diff --git a/twingate/internal/provider/datasource/security-policies.go b/twingate/internal/provider/datasource/security-policies.go
@@ -22,7 +22,7 @@ func SecurityPolicies() *schema.Resource {
 						attr.ID: {
 							Type:        schema.TypeString,
 							Computed:    true,
-							Description: "Return a matching Security Policy by its ID. The ID for the Security Policy must be obtained from the Admin API.",
+							Description: "Return a matching Security Policy by its ID. The ID for the Security Policy can be obtained from the Admin API or the URL string in the Admin Console.",
 						},
 						attr.Name: {
 							Type:        schema.TypeString,

diff --git a/twingate/internal/provider/datasource/security-policy.go b/twingate/internal/provider/datasource/security-policy.go
@@ -17,7 +17,7 @@ func SecurityPolicy() *schema.Resource {
 			attr.ID: {
 				Type:         schema.TypeString,
 				Optional:     true,
-				Description:  "Return a Security Policy by its ID. The ID for the Security Policy must be obtained from the Admin API.",
+				Description:  "Return a Security Policy by its ID. The ID for the Security Policy can be obtained from the Admin API or the URL string in the Admin Console.",
 				ExactlyOneOf: []string{attr.Name},
 			},
 			attr.Name: {

diff --git a/twingate/internal/provider/datasource/user.go b/twingate/internal/provider/datasource/user.go
@@ -53,7 +53,7 @@ func User() *schema.Resource {
 			attr.ID: {
 				Type:        schema.TypeString,
 				Required:    true,
-				Description: "The ID of the User. The ID for the User must be obtained from the Admin API.",
+				Description: "The ID of the User. The ID for the User can be obtained from the Admin API or the URL string in the Admin Console.",
 			},
 			// computed
 			attr.FirstName: {

diff --git a/twingate/internal/provider/resource/resource.go b/twingate/internal/provider/resource/resource.go
@@ -149,7 +149,7 @@ func Resource() *schema.Resource { //nolint:funlen
 			attr.Alias: {
 				Type:             schema.TypeString,
 				Optional:         true,
-				Description:      "Resource alias address",
+				Description:      "Set a DNS alias address for the Resource. Must be a DNS-valid name string.",
 				DiffSuppressFunc: aliasDiff,
 			},
 			attr.ID: {