Merge pull request #83 from metadaddy/expand-endpoint-doc

Explain that users should not need to set the endpoint

CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 * Fixed `allowed_operations` stability issue
 * Use macos-14 for ARM as macos-13-large is Intel
+* Clarified the purpose of the `endpoint`/`B2_ENDPOINT` configuration value
 
 ## [0.8.12] - 2024-06-20
 

README.md

@@ -31,6 +31,17 @@ Building
 make build
 ```
 
+Documentation
+-------------
+
+The documentation is generated from the provider source code using
+[`tfplugindocs`](https://github.com/hashicorp/terraform-plugin-docs). You will need to regenerate the documentation if
+you add or change a data source, resource or argument.
+
+```
+make docs
+```
+
 Installing
 ----------
 

b2/provider.go

@@ -50,7 +50,8 @@ func New(version string, exec string) func() *schema.Provider {
 					DefaultFunc: schema.EnvDefaultFunc("B2_APPLICATION_KEY", nil),
 				},
 				"endpoint": {
-					Description: "B2 endpoint - production or custom URL (B2_ENDPOINT env)",
+					Description: "B2 endpoint - the string 'production' or a custom B2 API URL (B2_ENDPOINT env)." +
+						" Defaults to 'production'. You should not need to set this unless you work at Backblaze.",
 					Type:        schema.TypeString,
 					Optional:    true,
 					DefaultFunc: schema.EnvDefaultFunc("B2_ENDPOINT", "production"),

docs/index.md

@@ -42,4 +42,4 @@ resource "b2_bucket" "example_bucket" {
 
 - `application_key` (String, Sensitive) B2 Application Key (B2_APPLICATION_KEY env)
 - `application_key_id` (String, Sensitive) B2 Application Key ID (B2_APPLICATION_KEY_ID env)
-- `endpoint` (String) B2 endpoint - production or custom URL (B2_ENDPOINT env)
+- `endpoint` (String) B2 endpoint - the string 'production' or a custom B2 API URL (B2_ENDPOINT env). Defaults to 'production'. You should not need to set this unless you work at Backblaze.