Workspace data source

.github/workflows/test.yml

@@ -45,7 +45,7 @@ jobs:
       - run: go generate ./...
       - name: git diff
         run: |
-          git diff --compact-summary --exit-code || \
+          git diff --exit-code || \
             (echo; echo "Unexpected difference in directories after code generation. Run 'go generate ./...' command and commit."; exit 1)
 
   # Run acceptance tests in a matrix with Terraform CLI versions

docs/data-sources/publicapi_workspace.md

@@ -0,0 +1,27 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "publicapi_workspace Data Source - terraform-provider-public-api"
+subcategory: ""
+description: |-
+  The Workspace.
+---
+
+# publicapi_workspace (Data Source)
+
+The Workspace.
+
+## Example Usage
+
+```terraform
+# Gets the workspace info
+data "publicapi_workspace" "my_workspace" {}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Read-Only
+
+- `id` (String) The unique identifier.
+- `name` (String) The human-readable name.
+- `slug` (String) The URL-friendly slug.

docs/index.md

@@ -1,26 +1,30 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "scaffolding-framework Provider"
+page_title: "public-api Provider"
 subcategory: ""
 description: |-
-
+  The Public API provider.
 ---
 
-# scaffolding-framework Provider
-
+# public-api Provider
 
+The Public API provider.
 
 ## Example Usage
 
 ```terraform
-provider "scaffolding" {
-  # example configuration here
-}
+# Configuration for the provider
+# Token can be passed through environment variable PUBLIC_API_TOKEN
+provider "publicapi" {}
 ```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
+### Required
+
+- `token` (String, Sensitive) The Public API token. If not set, the PUBLIC_API_TOKEN environment variable will be used.
+
 ### Optional
 
-- `endpoint` (String) Example provider attribute
+- `url` (String) The Public API url. If not set, the PUBLIC_API_URL environment variable will be used, or a default of 'api.segmentapis.com'.

examples/data-sources/publicapi_workspace/data-source.tf

@@ -0,0 +1,2 @@
+# Gets the workspace info
+data "publicapi_workspace" "my_workspace" {}

examples/provider-install-verification/main.tf

@@ -0,0 +1,16 @@
+terraform {
+  required_providers {
+    publicapi = {
+      source  = "registry.terraform.io/hashicorp/public-api"
+      version = "0.0.1"
+    }
+  }
+}
+
+provider "publicapi" {}
+
+data "publicapi_workspace" "example" {}
+
+output "workspace" {
+  value = data.publicapi_workspace.example
+}

examples/provider/provider.tf

@@ -1,3 +1,3 @@
-provider "scaffolding" {
-  # example configuration here
-}
+# Configuration for the provider
+# Token can be passed through environment variable PUBLIC_API_TOKEN
+provider "publicapi" {}

go.mod

@@ -1,13 +1,13 @@
-module github.com/hashicorp/terraform-provider-scaffolding-framework
+module terraform-provider-public-api
 
 go 1.19
 
 require (
 	github.com/hashicorp/terraform-plugin-docs v0.16.0
 	github.com/hashicorp/terraform-plugin-framework v1.3.3
 	github.com/hashicorp/terraform-plugin-go v0.18.0
-	github.com/hashicorp/terraform-plugin-log v0.9.0
 	github.com/hashicorp/terraform-plugin-testing v1.4.0
+	github.com/segmentio/public-api-sdk-go v0.0.0-20230731214639-bee26edfa972
 )
 
 require (
@@ -38,6 +38,7 @@ require (
 	github.com/hashicorp/logutils v1.0.0 // indirect
 	github.com/hashicorp/terraform-exec v0.18.1 // indirect
 	github.com/hashicorp/terraform-json v0.17.1 // indirect
+	github.com/hashicorp/terraform-plugin-log v0.9.0 // indirect
 	github.com/hashicorp/terraform-plugin-sdk/v2 v2.27.0 // indirect
 	github.com/hashicorp/terraform-registry-address v0.2.1 // indirect
 	github.com/hashicorp/terraform-svchost v0.1.1 // indirect
@@ -65,6 +66,7 @@ require (
 	golang.org/x/exp v0.0.0-20230626212559-97b1e661b5df // indirect
 	golang.org/x/mod v0.11.0 // indirect
 	golang.org/x/net v0.11.0 // indirect
+	golang.org/x/oauth2 v0.7.0 // indirect
 	golang.org/x/sys v0.10.0 // indirect
 	golang.org/x/text v0.11.0 // indirect
 	google.golang.org/appengine v1.6.7 // indirect