Merge pull request #45 from julianleonard123/update-docs-to-authzed-name

Verolop · web-flow · commit ba2d516adc67 · 2025-06-06T09:19:25.000-06:00
docs: update docs from `cloudapi` to `authzed`
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 # Build artifacts
 dist/
+terraform-provider-authzed
 # IDE files
 .idea/
 .vscode/
diff --git a/.tfrepo b/.tfrepo
@@ -3,6 +3,6 @@ provider_installation {
     url = "https://terraform.releases.hashicorp.com"
   }
   direct {
-    exclude = ["registry.terraform.io/authzed/cloudapi"]
+    exclude = ["registry.terraform.io/authzed/authzed"]
   }
 } 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
-# Contributing to the AuthZed Cloud API Terraform Provider
+# Contributing to the AuthZed Terraform Provider
 
-Thank you for considering contributing to the AuthZed Cloud API Terraform Provider! This document provides guidelines and instructions for contributing.
+Thank you for considering contributing to the AuthZed Terraform Provider! This document provides guidelines and instructions for contributing.
 
 ## Code of Conduct
 
@@ -11,7 +11,7 @@ Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
 1. **Fork the repository** on GitHub.
 2. **Clone your fork** locally:
    ```
-   git clone https://github.com/YOUR-USERNAME/terraform-provider-cloudapi.git
+   git clone https://github.com/YOUR-USERNAME/terraform-provider-authzed.git
    ```
 3. **Create a branch** for your work:
    ```
@@ -23,7 +23,7 @@ Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
 ### Requirements
 
 - Go 1.23 or higher
-- Terraform 1.0 or higher
+- Terraform 1.12 or higher
 - Access to an AuthZed Cloud account for testing
 
 ### Building and Testing
@@ -40,8 +40,8 @@ Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
 
 3. **Install locally for testing**:
    ```
-   mkdir -p ~/.terraform.d/plugins/registry.terraform.io/authzed/cloudapi/0.1.0/$(go env GOOS)_$(go env GOARCH)
-   cp terraform-provider-cloudapi ~/.terraform.d/plugins/registry.terraform.io/authzed/cloudapi/0.1.0/$(go env GOOS)_$(go env GOARCH)/
+   mkdir -p ~/.terraform.d/plugins/registry.terraform.io/authzed/authzed/0.1.0/$(go env GOOS)_$(go env GOARCH)
+   cp terraform-provider-authzed ~/.terraform.d/plugins/registry.terraform.io/authzed/authzed/0.1.0/$(go env GOOS)_$(go env GOARCH)/
    ```
 
 ## Making Changes
diff --git a/README.md b/README.md
@@ -1,13 +1,13 @@
-# Terraform Provider for AuthZed Cloud API
+# Terraform Provider for AuthZed
 
-A Terraform provider for managing administrative access to [AuthZed](https://authzed.com/) through its Cloud API.
+A Terraform provider for managing [AuthZed](https://authzed.com/) resources through its Cloud API.
 
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
 [![Terraform Registry](https://img.shields.io/badge/Terraform%20Registry-AuthZed-blue.svg)](https://registry.terraform.io/providers/authzed/authzed/latest/docs)
 
 ## Overview
 
-This provider automates the management of platform access in AuthZed Dedicated environments:
+This provider automates the management of resources in AuthZed Dedicated environments:
 
 - **Service accounts** for programmatic access to permission systems
 - **API tokens** for secure authentication
diff --git a/docs/data-sources/permission_system.md b/docs/data-sources/permission_system.md
@@ -1,26 +1,26 @@
 ---
-page_title: "Data Source: cloudapi_permission_system"
+page_title: "Data Source: authzed_permission_system"
 description: |-
   Retrieves information about a specific permission system in AuthZed.
 ---
 
-# cloudapi_permission_system
+# authzed_permission_system
 
 This data source retrieves information about a specific permission system in your AuthZed account. Permission systems are where you define and store your permission relationships.
 
 ## Example Usage
 
 ```terraform
-data "cloudapi_permission_system" "development" {
+data "authzed_permission_system" "development" {
   id = "ps-123456789"
 }
 
 output "system_name" {
-  value = data.cloudapi_permission_system.development.name
+  value = data.authzed_permission_system.development.name
 }
 
 output "system_type" {
-  value = data.cloudapi_permission_system.development.system_type
+  value = data.authzed_permission_system.development.system_type
 }
 ```
 
diff --git a/docs/data-sources/permission_systems.md b/docs/data-sources/permission_systems.md
@@ -1,24 +1,24 @@
 ---
-page_title: "Data Source: cloudapi_permission_systems"
+page_title: "Data Source: authzed_permission_systems"
 description: |-
   Lists all permission systems available in your AuthZed account.
 ---
 
-# cloudapi_permission_systems
+# authzed_permission_systems
 
 This data source retrieves information about all permission systems in your AuthZed account. Use this to discover your permission systems and their properties.
 
 ## Example Usage
 
 ```terraform
-data "cloudapi_permission_systems" "all" {}
+data "authzed_permission_systems" "all" {}
 
 output "all_system_names" {
-  value = [for ps in data.cloudapi_permission_systems.all.permission_systems : ps.name]
+  value = [for ps in data.authzed_permission_systems.all.permission_systems : ps.name]
 }
 
 output "system_count" {
-  value = data.cloudapi_permission_systems.all.permission_systems_count
+  value = data.authzed_permission_systems.all.permission_systems_count
 }
 ```
 
diff --git a/docs/data-sources/policies.md b/docs/data-sources/policies.md
@@ -1,23 +1,23 @@
 ---
-page_title: "Policies Data Source - cloudapi"
+page_title: "Data Source: authzed_policies"
 subcategory: ""
 description: |-
   Lists all policies in a permission system.
 ---
 
-# cloudapi_policies (Data Source)
+# authzed_policies (Data Source)
 
 This data source retrieves a list of all policies defined in an AuthZed Cloud permission system.
 
 ## Example Usage
 
 ```terraform
-data "cloudapi_policies" "all" {
+data "authzed_policies" "all" {
   permission_system_id = "sys_123456789"
 }
 
 output "policy_names" {
-  value = [for policy in data.cloudapi_policies.all.policies : policy.name]
+  value = [for policy in data.authzed_policies.all.policies : policy.name]
 }
 ```
 
diff --git a/docs/data-sources/policy.md b/docs/data-sources/policy.md
@@ -1,23 +1,23 @@
 ---
-page_title: "Data Source: cloudapi_policy"
+page_title: "Data Source: authzed_policy"
 description: |-
   Gets information about a specific policy in a permission system.
 ---
 
-# cloudapi_policy
+# authzed_policy (Data Source)
 
 This data source retrieves information about a specific policy in an AuthZed permission system.
 
 ## Example Usage
 
 ```terraform
-data "cloudapi_policy" "example" {
+data "authzed_policy" "example" {
   permission_system_id = "ps-123456789"
   policy_id            = "apc-abcdef123456"
 }
 
 output "policy_roles" {
-  value = data.cloudapi_policy.example.role_ids
+  value = data.authzed_policy.example.role_ids
 }
 ```
 
diff --git a/docs/data-sources/role.md b/docs/data-sources/role.md
@@ -1,23 +1,23 @@
 ---
-page_title: "Data Source: cloudapi_role"
+page_title: "Data Source: authzed_role"
 description: |-
   Gets information about a specific role in a permission system.
 ---
 
-# cloudapi_role
+# authzed_role (Data Source)
 
 This data source retrieves information about a specific role in an AuthZed permission system.
 
 ## Example Usage
 
 ```terraform
-data "cloudapi_role" "example" {
+data "authzed_role" "example" {
   permission_system_id = "ps-123456789"
   role_id             = "arl-abcdef123456"
 }
 
 output "role_permissions" {
-  value = data.cloudapi_role.example.permissions
+  value = data.authzed_role.example.permissions
 }
 ```
 
diff --git a/docs/data-sources/roles.md b/docs/data-sources/roles.md
@@ -1,22 +1,22 @@
 ---
-page_title: "Data Source: cloudapi_roles"
+page_title: "Data Source: authzed_roles"
 description: |-
   Lists all roles in a permission system.
 ---
 
-# cloudapi_roles
+# authzed_roles (Data Source)
 
 This data source retrieves a list of all roles defined in an AuthZed permission system.
 
 ## Example Usage
 
 ```terraform
-data "cloudapi_roles" "all" {
+data "authzed_roles" "all" {
   permission_system_id = "sys_123456789"
 }
 
 output "role_names" {
-  value = [for role in data.cloudapi_roles.all.roles : role.name]
+  value = [for role in data.authzed_roles.all.roles : role.name]
 }
 ```
 
diff --git a/docs/data-sources/service_account.md b/docs/data-sources/service_account.md
@@ -1,24 +1,24 @@
 ---
-page_title: "Service Account Data Source - cloudapi"
+page_title: "Data Source: authzed_service_account"
 subcategory: ""
 description: |-
   Gets information about a specific service account in a permission system.
 ---
 
-# cloudapi_service_account (Data Source)
+# authzed_service_account (Data Source)
 
 This data source retrieves information about a specific service account in an AuthZed Cloud permission system.
 
 ## Example Usage
 
 ```terraform
-data "cloudapi_service_account" "example" {
+data "authzed_service_account" "example" {
   permission_system_id = "ps-123456789"
   service_account_id   = "asa-abcdef123456"
 }
 
 output "service_account_name" {
-  value = data.cloudapi_service_account.example.name
+  value = data.authzed_service_account.example.name
 }
 ```
 
diff --git a/docs/data-sources/service_accounts.md b/docs/data-sources/service_accounts.md
@@ -1,23 +1,23 @@
 ---
-page_title: "Service Accounts Data Source - cloudapi"
+page_title: "Data Source: authzed_service_accounts"
 subcategory: ""
 description: |-
   Lists all service accounts in a permission system.
 ---
 
-# cloudapi_service_accounts (Data Source)
+# authzed_service_accounts (Data Source)
 
 This data source retrieves a list of all service accounts defined in an AuthZed Cloud permission system.
 
 ## Example Usage
 
 ```terraform
-data "cloudapi_service_accounts" "all" {
+data "authzed_service_accounts" "all" {
   permission_system_id = "sys_123456789"
 }
 
 output "service_account_names" {
-  value = [for sa in data.cloudapi_service_accounts.all.service_accounts : sa.name]
+  value = [for sa in data.authzed_service_accounts.all.service_accounts : sa.name]
 }
 ```
 
diff --git a/docs/data-sources/token.md b/docs/data-sources/token.md
@@ -1,24 +1,24 @@
 ---
-page_title: "Data Source: cloudapi_token"
+page_title: "Data Source: authzed_token"
 description: |-
   Gets information about a specific token belonging to a service account.
 ---
 
-# cloudapi_token
+# authzed_token (Data Source)
 
 This data source retrieves information about a specific token belonging to a service account in an AuthZed permission system.
 
 ## Example Usage
 
 ```terraform
-data "cloudapi_token" "example" {
+data "authzed_token" "example" {
   permission_system_id = "ps-123456789"
   service_account_id   = "asa-abcdef123456"
   token_id            = "atk-987654321"
 }
 
 output "token_name" {
-  value = data.cloudapi_token.example.name
+  value = data.authzed_token.example.name
 }
 ```
 
diff --git a/docs/data-sources/tokens.md b/docs/data-sources/tokens.md
@@ -1,24 +1,24 @@
 ---
-page_title: "Tokens Data Source - cloudapi"
+page_title: "Data Source: authzed_tokens"
 subcategory: ""
 description: |-
   Lists all tokens for a service account in a permission system.
 ---
 
-# cloudapi_tokens (Data Source)
+# authzed_tokens (Data Source)
 
 This data source retrieves a list of all tokens belonging to a service account in an AuthZed Cloud permission system.
 
 ## Example Usage
 
 ```terraform
-data "cloudapi_tokens" "all" {
+data "authzed_tokens" "all" {
   permission_system_id = "ps-123456789"
   service_account_id   = "asa-abcdef123456"
 }
 
 output "token_names" {
-  value = [for token in data.cloudapi_tokens.all.tokens : token.name]
+  value = [for token in data.authzed_tokens.all.tokens : token.name]
 }
 ```
 
diff --git a/docs/guides/getting-started.md b/docs/guides/getting-started.md
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/resources/policy.md b/docs/resources/policy.md
diff --git a/docs/resources/role.md b/docs/resources/role.md

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,6 @@ provider_installation {`
`3`	`3`	`url = "https://terraform.releases.hashicorp.com"`
`4`	`4`	`}`
`5`	`5`	`direct {`
`6`		`- exclude = ["registry.terraform.io/authzed/cloudapi"]`
	`6`	`+ exclude = ["registry.terraform.io/authzed/authzed"]`
`7`	`7`	`}`
`8`	`8`	`}`