From 4343e2b4460f6ca0daba744c53c6620788c96e0f Mon Sep 17 00:00:00 2001 From: Bill Gale Date: Thu, 9 Nov 2023 15:57:37 +0000 Subject: [PATCH] chore: add punctation --- docs/index.md | 6 +++--- internal/provider/provider.go | 6 +++--- internal/v6provider/v6provider.go | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/index.md b/docs/index.md index 3c7f9166..86e21e79 100644 --- a/docs/index.md +++ b/docs/index.md @@ -33,10 +33,10 @@ provider "katapult" { ### Optional -- `api_key` (String, Sensitive) **REQUIRED** via config or environment variableAPI Key for Katapult Core API. Can be specified with the `KATAPULT_API_KEY` environment variable. -- `data_center` (String) **REQUIRED** via config or environment variableData center permalink. Can be specified with the `KATAPULT_DATA_CENTER` environment variable. +- `api_key` (String, Sensitive) **REQUIRED** via config or environment variable. API Key for Katapult Core API. Can be specified with the `KATAPULT_API_KEY` environment variable. +- `data_center` (String) **REQUIRED** via config or environment variable. Data center permalink. Can be specified with the `KATAPULT_DATA_CENTER` environment variable. - `log_level` (String) Log level used by Katapult Terraform provider. Can be specified with the `KATAPULT_LOG_LEVEL` environment variable. Defaults to `info`. -- `organization` (String) **REQUIRED** via config or environment variableOrganization sub-domain. Can be specified with the `KATAPULT_ORGANIZATION` environment variable. +- `organization` (String) **REQUIRED** via config or environment variable. Organization sub-domain. Can be specified with the `KATAPULT_ORGANIZATION` environment variable. - `skip_trash_object_purge` (Boolean) Skip purging deleted resources from Katapult's trash when they are destroyed by Terraform. Only relevant to some resources which are moved to the trash when they are deleted. Can be specified with the `KATAPULT_SKIP_TRASH_OBJECT_PURGE` environment variable. Defaults to `false`. diff --git a/internal/provider/provider.go b/internal/provider/provider.go index a703a852..e13ff964 100644 --- a/internal/provider/provider.go +++ b/internal/provider/provider.go @@ -59,7 +59,7 @@ func New(c *Config) func() *schema.Provider { //nolint:funlen Optional: true, Sensitive: true, Description: "**REQUIRED** via config or " + - "environment variable" + + "environment variable. " + "API Key for Katapult Core API. Can be " + "specified with the `KATAPULT_API_KEY` environment " + "variable.", @@ -69,7 +69,7 @@ func New(c *Config) func() *schema.Provider { //nolint:funlen Optional: true, Description: "**REQUIRED** via config or " + - "environment variable" + + "environment variable. " + "Organization sub-domain. Can be " + "specified with the `KATAPULT_ORGANIZATION` " + "environment variable.", @@ -79,7 +79,7 @@ func New(c *Config) func() *schema.Provider { //nolint:funlen Optional: true, Description: "**REQUIRED** via config or " + - "environment variable" + + "environment variable. " + "Data center permalink. Can be " + "specified with the `KATAPULT_DATA_CENTER` " + "environment variable.", diff --git a/internal/v6provider/v6provider.go b/internal/v6provider/v6provider.go index 61f5dab9..7dc3717c 100644 --- a/internal/v6provider/v6provider.go +++ b/internal/v6provider/v6provider.go @@ -73,7 +73,7 @@ func (k *KatapultProvider) Schema( Optional: true, Sensitive: true, MarkdownDescription: "**REQUIRED** via config or " + - "environment variable" + + "environment variable. " + "API Key for Katapult Core API. Can be " + "specified with the `KATAPULT_API_KEY` environment " + "variable.", @@ -81,7 +81,7 @@ func (k *KatapultProvider) Schema( "organization": schema.StringAttribute{ Optional: true, MarkdownDescription: "**REQUIRED** via config or " + - "environment variable" + + "environment variable. " + "Organization sub-domain. Can be " + "specified with the `KATAPULT_ORGANIZATION` " + "environment variable.", @@ -89,7 +89,7 @@ func (k *KatapultProvider) Schema( "data_center": schema.StringAttribute{ Optional: true, MarkdownDescription: "**REQUIRED** via config or " + - "environment variable" + + "environment variable. " + "Data center permalink. Can be " + "specified with the `KATAPULT_DATA_CENTER` " + "environment variable.",