feat: support name based searches in data sources

Author: cvhariharan

docs/data-sources/role.md

@@ -14,6 +14,8 @@ Retrieves information about a specific role in WarpGate.
 ```hcl
 data "warpgate_role" "developers" {
   id = "12345678-1234-1234-1234-123456789012"
+  // optionally
+  // name = "developers"
 }
 
 output "role_name" {
@@ -31,16 +33,20 @@ resource "warpgate_user_role" "eugene_developer" {
 
 The following arguments are supported:
 
-* `id` - (Required) The ID of the role to look up.
+- `id` - The ID of the role to look up.
+- `name` - The name of the role to look up.
+
+Either `id` or `name` should be specified.
 
 ## Attribute Reference
 
 In addition to the arguments listed above, the following attributes are exported:
 
-* `name` - The name of the role.
-* `description` - The description of the role.
+- `name` - The name of the role.
+- `description` - The description of the role.
 
 <!-- schema generated by tfplugindocs -->
+
 ## Schema
 
 ### Required

docs/data-sources/target.md

@@ -14,6 +14,8 @@ Retrieves information about a specific target in Warpgate. This data source allo
 ```hcl
 data "warpgate_target" "web_server" {
   id = "12345678-1234-1234-1234-123456789012"
+  // optionally
+  // name = "webserver"
 }
 
 output "target_name" {
@@ -42,20 +44,20 @@ locals {
   is_http     = length(data.warpgate_target.server.http_options) > 0
   is_mysql    = length(data.warpgate_target.server.mysql_options) > 0
   is_postgres = length(data.warpgate_target.server.postgres_options) > 0
-  
+
   # Safely access target details
   host = local.is_ssh ? data.warpgate_target.server.ssh_options[0].host :
          local.is_http ? "<HTTP target>" :
          local.is_mysql ? data.warpgate_target.server.mysql_options[0].host :
-         local.is_postgres ? data.warpgate_target.server.postgres_options[0].host : 
+         local.is_postgres ? data.warpgate_target.server.postgres_options[0].host :
          "unknown"
 }
 
 output "target_type" {
-  value = local.is_ssh ? "SSH" : 
-          local.is_http ? "HTTP" : 
-          local.is_mysql ? "MySQL" : 
-          local.is_postgres ? "PostgreSQL" : 
+  value = local.is_ssh ? "SSH" :
+          local.is_http ? "HTTP" :
+          local.is_mysql ? "MySQL" :
+          local.is_postgres ? "PostgreSQL" :
           "unknown"
 }
 
@@ -68,54 +70,58 @@ output "target_host" {
 
 The following arguments are supported:
 
-* `id` - (Required) The ID of the target to look up.
+- `id` - The ID of the target to look up.
+- `name` - The name of the target to look up.
+
+Either `id` or `name` should be specified.
 
 ## Attribute Reference
 
 In addition to the arguments listed above, the following attributes are exported:
 
-* `name` - The name of the target.
-* `description` - The description of the target.
-* `allow_roles` - The list of roles allowed to access this target.
+- `name` - The name of the target.
+- `description` - The description of the target.
+- `allow_roles` - The list of roles allowed to access this target.
 
 Based on the target type, one of the following option blocks will be populated:
 
-* `ssh_options` - Configuration for SSH targets.
-  * `host` - The SSH server hostname or IP address.
-  * `port` - The SSH server port.
-  * `username` - The SSH username.
-  * `allow_insecure_algos` - Whether insecure SSH algorithms are allowed.
-  * `password_auth` - Password authentication configuration (if applicable).
-    * `password` - The password for SSH authentication.
-  * `public_key_auth` - Public key authentication configuration (if applicable).
-
-* `http_options` - Configuration for HTTP targets.
-  * `url` - The HTTP server URL.
-  * `tls` - TLS configuration.
-    * `mode` - TLS mode (Disabled, Preferred, Required).
-    * `verify` - Whether TLS certificates are verified.
-  * `headers` - HTTP headers included in requests.
-  * `external_host` - External host for HTTP requests.
-
-* `mysql_options` - Configuration for MySQL targets.
-  * `host` - The MySQL server hostname or IP address.
-  * `port` - The MySQL server port.
-  * `username` - The MySQL username.
-  * `password` - The MySQL password.
-  * `tls` - TLS configuration.
-    * `mode` - TLS mode (Disabled, Preferred, Required).
-    * `verify` - Whether TLS certificates are verified.
-
-* `postgres_options` - Configuration for PostgreSQL targets.
-  * `host` - The PostgreSQL server hostname or IP address.
-  * `port` - The PostgreSQL server port.
-  * `username` - The PostgreSQL username.
-  * `password` - The PostgreSQL password.
-  * `tls` - TLS configuration.
-    * `mode` - TLS mode (Disabled, Preferred, Required).
-    * `verify` - Whether TLS certificates are verified.
+- `ssh_options` - Configuration for SSH targets.
+  - `host` - The SSH server hostname or IP address.
+  - `port` - The SSH server port.
+  - `username` - The SSH username.
+  - `allow_insecure_algos` - Whether insecure SSH algorithms are allowed.
+  - `password_auth` - Password authentication configuration (if applicable).
+    - `password` - The password for SSH authentication.
+  - `public_key_auth` - Public key authentication configuration (if applicable).
+
+- `http_options` - Configuration for HTTP targets.
+  - `url` - The HTTP server URL.
+  - `tls` - TLS configuration.
+    - `mode` - TLS mode (Disabled, Preferred, Required).
+    - `verify` - Whether TLS certificates are verified.
+  - `headers` - HTTP headers included in requests.
+  - `external_host` - External host for HTTP requests.
+
+- `mysql_options` - Configuration for MySQL targets.
+  - `host` - The MySQL server hostname or IP address.
+  - `port` - The MySQL server port.
+  - `username` - The MySQL username.
+  - `password` - The MySQL password.
+  - `tls` - TLS configuration.
+    - `mode` - TLS mode (Disabled, Preferred, Required).
+    - `verify` - Whether TLS certificates are verified.
+
+- `postgres_options` - Configuration for PostgreSQL targets.
+  - `host` - The PostgreSQL server hostname or IP address.
+  - `port` - The PostgreSQL server port.
+  - `username` - The PostgreSQL username.
+  - `password` - The PostgreSQL password.
+  - `tls` - TLS configuration.
+    - `mode` - TLS mode (Disabled, Preferred, Required).
+    - `verify` - Whether TLS certificates are verified.
 
 <!-- schema generated by tfplugindocs -->
+
 ## Schema
 
 ### Required
@@ -133,6 +139,7 @@ Based on the target type, one of the following option blocks will be populated:
 - `ssh_options` (List of Object) SSH target options (see [below for nested schema](#nestedatt--ssh_options))
 
 <a id="nestedatt--http_options"></a>
+
 ### Nested Schema for `http_options`
 
 Read-Only:
@@ -143,16 +150,16 @@ Read-Only:
 - `url` (String)
 
 <a id="nestedobjatt--http_options--tls"></a>
+
 ### Nested Schema for `http_options.tls`
 
 Read-Only:
 
 - `mode` (String)
 - `verify` (Boolean)
 
-
-
 <a id="nestedatt--mysql_options"></a>
+
 ### Nested Schema for `mysql_options`
 
 Read-Only:
@@ -164,16 +171,16 @@ Read-Only:
 - `username` (String)
 
 <a id="nestedobjatt--mysql_options--tls"></a>
+
 ### Nested Schema for `mysql_options.tls`
 
 Read-Only:
 
 - `mode` (String)
 - `verify` (Boolean)
 
-
-
 <a id="nestedatt--postgres_options"></a>
+
 ### Nested Schema for `postgres_options`
 
 Read-Only:
@@ -185,16 +192,16 @@ Read-Only:
 - `username` (String)
 
 <a id="nestedobjatt--postgres_options--tls"></a>
+
 ### Nested Schema for `postgres_options.tls`
 
 Read-Only:
 
 - `mode` (String)
 - `verify` (Boolean)
 
-
-
 <a id="nestedatt--ssh_options"></a>
+
 ### Nested Schema for `ssh_options`
 
 Read-Only:
@@ -207,14 +214,15 @@ Read-Only:
 - `username` (String)
 
 <a id="nestedobjatt--ssh_options--password_auth"></a>
+
 ### Nested Schema for `ssh_options.password_auth`
 
 Read-Only:
 
 - `password` (String)
 
-
 <a id="nestedobjatt--ssh_options--public_key_auth"></a>
+
 ### Nested Schema for `ssh_options.public_key_auth`
 
 Read-Only:

docs/data-sources/user.md

@@ -14,6 +14,8 @@ Retrieves information about a specific user in WarpGate.
 ```hcl
 data "warpgate_user" "eugene" {
   id = "12345678-1234-1234-1234-123456789012"
+  // optionally
+  // username = "eugene"
 }
 
 output "username" {
@@ -45,23 +47,26 @@ locals {
 
 The following arguments are supported:
 
-* `id` - (Required) The ID of the user to look up.
+- `id` - The ID of the user to look up.
+- `username` - The username of the user to look up
+
+Either `id` or `username` should be specified.
 
 ## Attribute Reference
 
 In addition to the arguments listed above, the following attributes are exported:
 
-* `username` - The username of the user.
-* `description` - The description of the user.
-* `credential_policy` - The credential policy for the user. This is a list with a single element.
-  * `http` - List of credential types required for HTTP access.
-  * `ssh` - List of credential types required for SSH access.
-  * `mysql` - List of credential types required for MySQL access.
-  * `postgres` - List of credential types required for PostgreSQL access.
-* `sso_credentials` - List of SSO credentials associated with the user.
-  * `id` - The ID of the SSO credential.
-  * `sso_provider` - The SSO provider name (e.g., 'google', 'github', 'okta').
-  * `email` - The email address associated with the SSO provider.
+- `username` - The username of the user.
+- `description` - The description of the user.
+- `credential_policy` - The credential policy for the user. This is a list with a single element.
+  - `http` - List of credential types required for HTTP access.
+  - `ssh` - List of credential types required for SSH access.
+  - `mysql` - List of credential types required for MySQL access.
+  - `postgres` - List of credential types required for PostgreSQL access.
+- `sso_credentials` - List of SSO credentials associated with the user.
+  - `id` - The ID of the SSO credential.
+  - `sso_provider` - The SSO provider name (e.g., 'google', 'github', 'okta').
+  - `email` - The email address associated with the SSO provider.
 
 ## Working with Credential Policies
 
@@ -91,6 +96,7 @@ locals {
 ```
 
 <!-- schema generated by tfplugindocs -->
+
 ## Schema
 
 ### Required
@@ -105,6 +111,7 @@ locals {
 - `username` (String) The username of the user
 
 <a id="nestedatt--credential_policy"></a>
+
 ### Nested Schema for `credential_policy`
 
 Read-Only:
@@ -115,6 +122,7 @@ Read-Only:
 - `ssh` (List of String)
 
 <a id="nestedatt--sso_credentials"></a>
+
 ### Nested Schema for `sso_credentials`
 
 Read-Only:

internal/client/role.go

@@ -24,11 +24,14 @@ type RoleCreateRequest struct {
 // the provided search term.
 func (c *Client) GetRoles(ctx context.Context, search string) ([]Role, error) {
 	path := "/roles"
-	if search != "" {
-		path = fmt.Sprintf("%s?search=%s", path, search)
+
+	req, err := http.NewRequest(http.MethodGet, path, nil)
+	if err != nil {
+		return nil, err
 	}
+	req.URL.Query().Add("search", search)
 
-	resp, err := c.doRequest(ctx, http.MethodGet, path, nil)
+	resp, err := c.doRequest(ctx, http.MethodGet, req.URL.Path, nil)
 	if err != nil {
 		return nil, err
 	}

internal/client/target.go

@@ -101,11 +101,13 @@ type TargetDataRequest struct {
 // the provided search term.
 func (c *Client) GetTargets(ctx context.Context, search string) ([]Target, error) {
 	path := "/targets"
-	if search != "" {
-		path = fmt.Sprintf("%s?search=%s", path, search)
+	req, err := http.NewRequest(http.MethodGet, path, nil)
+	if err != nil {
+		return nil, err
 	}
+	req.URL.Query().Add("search", search)
 
-	resp, err := c.doRequest(ctx, http.MethodGet, path, nil)
+	resp, err := c.doRequest(ctx, http.MethodGet, req.URL.Path, nil)
 	if err != nil {
 		return nil, err
 	}

internal/client/user.go

@@ -58,11 +58,14 @@ type UserUpdateRequest struct {
 // the provided search term.
 func (c *Client) GetUsers(ctx context.Context, search string) ([]User, error) {
 	path := "/users"
-	if search != "" {
-		path = fmt.Sprintf("%s?search=%s", path, search)
+
+	req, err := http.NewRequest(http.MethodGet, path, nil)
+	if err != nil {
+		return nil, err
 	}
+	req.URL.Query().Add("search", search)
 
-	resp, err := c.doRequest(ctx, http.MethodGet, path, nil)
+	resp, err := c.doRequest(ctx, http.MethodGet, req.URL.Path, nil)
 	if err != nil {
 		return nil, err
 	}