docs & tests

komminarlabs · Feb 14, 2024 · a9eef01 · a9eef01
1 parent 0637bcc
commit a9eef01
Show file tree

Hide file tree

Showing 37 changed files with 177 additions and 193 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,42 @@
+<!---
+See what makes a good Pull Request at: https://hashicorp.github.io/terraform-provider-aws/raising-a-pull-request/
+--->
+### Description
+<!---
+Please provide a helpful description of what change this pull request will introduce.
+--->
+
+
+### Relations
+<!---
+If your pull request fully resolves and should automatically close the linked issue, use Closes. Otherwise, use Relates.
+
+For Example:
+
+Relates #0000
+or 
+Closes #0000
+--->
+
+Closes #0000
+
+### References
+<!---
+Optionally, provide any helpful references that may help the reviewer(s).
+--->
+
+
+### Output from Acceptance Testing
+<!--
+Replace TestAccXXX with a pattern that matches the tests affected by this PR.
+
+Replace ec2 with the service package corresponding to your tests.
+
+For more information on the `-run` flag, see the `go test` documentation at https://tip.golang.org/cmd/go/#hdr-Testing_flags.
+-->
+
+```console
+% make testacc
+
+...
+```
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
-## 0.1.0
+## [0.1.0] - 2024-02-14
+
+### Added:
 
-FEATURES:
 * **New Data Source:** `influxdb_authorization`
 * **New Data Source:** `influxdb_authorizations`
 * **New Data Source:** `influxdb_bucket`

diff --git a/GNUmakefile b/GNUmakefile
diff --git a/Makefile b/Makefile
@@ -0,0 +1,17 @@
+default: testacc
+
+# Run acceptance tests
+.PHONY: testacc
+testacc:
+	TF_ACC=1 go test ./... -v $(TESTARGS) -timeout 120m
+
+.PHONY: golint
+golint:
+	golangci-lint run
+
+.PHONY: docs
+docs:
+	export GOBIN=$PWD/bin
+	export PATH=$GOBIN:$PATH
+	go install github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs
+	tfplugindocs generate
diff --git a/README.md b/README.md
@@ -76,7 +76,7 @@ If you wish to work on the provider, you'll first need [Go](http://www.golang.or
 
 To compile the provider, run `go install`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
 
-To generate or update documentation, run `go generate`.
+To generate or update documentation, run `make docs`.
 
 In order to run the full suite of Acceptance tests, run `make testacc`.
 

diff --git a/docs/data-sources/authorization.md b/docs/data-sources/authorization.md
@@ -3,12 +3,12 @@
 page_title: "influxdb_authorization Data Source - terraform-provider-influxdb"
 subcategory: ""
 description: |-
-  
+  Retrieves an authorization. Use this data source to retrieve information about an API token, including the token's permissions and the user that the token is scoped to.
 ---
 
 # influxdb_authorization (Data Source)
 
-
+Retrieves an authorization. Use this data source to retrieve information about an API token, including the token's permissions and the user that the token is scoped to.
 
 
 

diff --git a/docs/data-sources/authorizations.md b/docs/data-sources/authorizations.md
@@ -3,12 +3,12 @@
 page_title: "influxdb_authorizations Data Source - terraform-provider-influxdb"
 subcategory: ""
 description: |-
-  
+  Lists all authorizations.
 ---
 
 # influxdb_authorizations (Data Source)
 
-
+Lists all authorizations.
 
 
 
@@ -22,14 +22,11 @@ description: |-
 <a id="nestedatt--authorizations"></a>
 ### Nested Schema for `authorizations`
 
-Required:
-
-- `id` (String) The authorization ID.
-
 Read-Only:
 
 - `created_at` (String) Authorizations creation date.
 - `description` (String) A description of the token.
+- `id` (String) The authorization ID.
 - `org` (String) An Organization name. Specifies the organization that owns the authorization.
 - `org_id` (String) An organization ID. Specifies the organization that owns the authorization.
 - `permissions` (Attributes List) A list of permissions for an authorization. (see [below for nested schema](#nestedatt--authorizations--permissions))

diff --git a/docs/data-sources/bucket.md b/docs/data-sources/bucket.md
@@ -3,12 +3,12 @@
 page_title: "influxdb_bucket Data Source - terraform-provider-influxdb"
 subcategory: ""
 description: |-
-  
+  Retrieves a bucket. Use this data source to retrieve information for a specific bucket.
 ---
 
 # influxdb_bucket (Data Source)
 
-
+Retrieves a bucket. Use this data source to retrieve information for a specific bucket.
 
 
 
@@ -26,6 +26,5 @@ description: |-
 - `id` (String) A Bucket ID.
 - `org_id` (String) An organization ID.
 - `retention_days` (Number) The retention days for the bucket.
-- `schema_type` (String) The Bucket schema type.
 - `type` (String) The Bucket type.
 - `updated_at` (String) Last bucket update date.
diff --git a/docs/data-sources/buckets.md b/docs/data-sources/buckets.md
@@ -3,12 +3,12 @@
 page_title: "influxdb_buckets Data Source - terraform-provider-influxdb"
 subcategory: ""
 description: |-
-  
+  Lists buckets. InfluxDB retrieves buckets owned by the organization associated with the authorization (API token).
 ---
 
 # influxdb_buckets (Data Source)
 
-
+Lists buckets. InfluxDB retrieves buckets owned by the organization associated with the authorization (API token).
 
 
 
@@ -30,6 +30,5 @@ Read-Only:
 - `name` (String) A Bucket name.
 - `org_id` (String) An organization ID.
 - `retention_days` (Number) The retention days for the bucket.
-- `schema_type` (String) The Bucket schema type.
 - `type` (String) The Bucket type.
 - `updated_at` (String) Last bucket update date.
diff --git a/docs/data-sources/organization.md b/docs/data-sources/organization.md
@@ -3,12 +3,12 @@
 page_title: "influxdb_organization Data Source - terraform-provider-influxdb"
 subcategory: ""
 description: |-
-  
+  Retrieves an organization. Use this data source to retrieve information for a specific organization.
 ---
 
 # influxdb_organization (Data Source)
 
-
+Retrieves an organization. Use this data source to retrieve information for a specific organization.
 
 
 

diff --git a/docs/data-sources/organizations.md b/docs/data-sources/organizations.md
@@ -3,12 +3,12 @@
 page_title: "influxdb_organizations Data Source - terraform-provider-influxdb"
 subcategory: ""
 description: |-
-  
+  Lists organizations. InfluxDB returns all organizations.
 ---
 
 # influxdb_organizations (Data Source)
 
-
+Lists organizations. InfluxDB returns all organizations.
 
 
 

diff --git a/docs/index.md b/docs/index.md
@@ -3,7 +3,7 @@
 page_title: "InfluxDB Provider"
 subcategory: ""
 description: |-
-  
+  Use the InfluxDB provider to deploy and manage resources supported by InfluxDB. You must configure the provider with the proper credentials before you can use it.
 ---
 
 # InfluxDB Provider
@@ -16,15 +16,6 @@ Use the InfluxDB provider to deploy and manage resources supported by InfluxDB.
 provider "influxdb" {}
 ```
 
-<!-- schema generated by tfplugindocs -->
-## Schema
-
-### Optional
-
-- `token` (String, Sensitive) An InfluxDB token string
-- `url` (String) The InfluxDB Cloud Dedicated server URL
-
-
 ## Environment Variables
 
 Credentials can be provided by using the `INFLUXDB_URL` and `INFLUXDB_TOKEN`.
@@ -39,3 +30,11 @@ export INFLUXDB_TOKEN="influxdb-token"
 
 terraform plan
 ```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Optional
+
+- `token` (String, Sensitive) An InfluxDB token string
+- `url` (String) The InfluxDB Cloud Dedicated server URL
diff --git a/docs/resources/authorization.md b/docs/resources/authorization.md
@@ -3,12 +3,12 @@
 page_title: "influxdb_authorization Resource - terraform-provider-influxdb"
 subcategory: ""
 description: |-
-  Manages an InfluxDB Authorization
+  Creates and manages an authorization and returns the authorization with the generated API token. Use this resource to create/manage an authorization, which generates an API token with permissions to read or write to a specific resource or type of resource.
 ---
 
 # influxdb_authorization (Resource)
 
-Manages an InfluxDB Authorization
+Creates and manages an authorization and returns the authorization with the generated API token. Use this resource to create/manage an authorization, which generates an API token with permissions to read or write to a specific resource or type of resource.
 
 
 

diff --git a/docs/resources/bucket.md b/docs/resources/bucket.md
@@ -3,12 +3,12 @@
 page_title: "influxdb_bucket Resource - terraform-provider-influxdb"
 subcategory: ""
 description: |-
-  Manages an InfluxDB bucket
+  Creates and manages a bucket.
 ---
 
 # influxdb_bucket (Resource)
 
-Manages an InfluxDB bucket
+Creates and manages a bucket.
 
 
 
@@ -30,5 +30,4 @@ Manages an InfluxDB bucket
 
 - `created_at` (String) Bucket creation date.
 - `id` (String) A Bucket ID.
-- `schema_type` (String) The Bucket schema type.
 - `updated_at` (String) Last bucket update date.
diff --git a/docs/resources/organization.md b/docs/resources/organization.md
@@ -3,12 +3,12 @@
 page_title: "influxdb_organization Resource - terraform-provider-influxdb"
 subcategory: ""
 description: |-
-  Manages an InfluxDB Organization
+  Creates and manages new organization.
 ---
 
 # influxdb_organization (Resource)
 
-Manages an InfluxDB Organization
+Creates and manages new organization.
 
 
 

diff --git a/internal/provider/authorization_data_source.go b/internal/provider/authorization_data_source.go
@@ -36,6 +36,8 @@ func (d *AuthorizationDataSource) Metadata(ctx context.Context, req datasource.M
 func (d *AuthorizationDataSource) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) {
 	resp.Schema = schema.Schema{
 		// This description is used by the documentation generator and the language server.
+		Description: "Retrieves an authorization. Use this data source to retrieve information about an API token, including the token's permissions and the user that the token is scoped to.",
+
 		Attributes: map[string]schema.Attribute{
 			"id": schema.StringAttribute{
 				Required:    true,

diff --git a/internal/provider/authorization_data_source_test.go b/internal/provider/authorization_data_source_test.go
diff --git a/internal/provider/authorization_resource.go b/internal/provider/authorization_resource.go
@@ -45,7 +45,7 @@ func (r *AuthorizationResource) Metadata(ctx context.Context, req resource.Metad
 func (r *AuthorizationResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {
 	resp.Schema = schema.Schema{
 		// This description is used by the documentation generator and the language server.
-		MarkdownDescription: "Manages an InfluxDB Authorization",
+		Description: "Creates and manages an authorization and returns the authorization with the generated API token. Use this resource to create/manage an authorization, which generates an API token with permissions to read or write to a specific resource or type of resource.",
 
 		Attributes: map[string]schema.Attribute{
 			"id": schema.StringAttribute{

diff --git a/internal/provider/authorization_resource_test.go b/internal/provider/authorization_resource_test.go