Fix docs

Author: cimnine

README.md

@@ -15,7 +15,7 @@ terraform {
   required_providers {
     publicip = {
       source = "nxt/publicip"
-      version = "x"
+      version = "~> 0.0.3"
     }
   }
 }

docs/data-sources/address.md

@@ -10,14 +10,27 @@ description: |-
 
 The current (public) IP as reported by the IP information provider.
 
+## Example Usage
 
+```terraform
+data "publicip_address" "default" {
+}
+
+data "publicip_address" "v4" {
+  ip_version = "v4"
+}
+
+data "publicip_address" "v6" {
+  ip_version = "v6"
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Optional
 
-- **ip_version** (String) Whether to use IPv4 or IPv6 only. Valid values: 'V4', 'V6'
+- **ip_version** (String) Whether to use IPv4 or IPv6 only. Valid values: 'v6', 'v4'
 
 ### Read-Only
 

docs/index.md

@@ -14,7 +14,12 @@ description: |-
 
 ```terraform
 provider "publicip" {
-  provider_url = "https://ifconfig.co/" # default value
+  provider_url = "https://ifconfig.co/" # optional
+  timeout      = "10s"                  # optional
+
+  # 1 request per 500ms
+  rate_limit_rate  = "500ms" # optional
+  rate_limit_burst = "1"     # optional
 }
 ```
 
@@ -23,7 +28,7 @@ provider "publicip" {
 
 ### Optional
 
-- **provider_url** (String) URL to a ifconfig.co-compatible IP information provider, defaults to `https://ifconfig.co/`.
+- **provider_url** (String) URL to an ifconfig.co-compatible IP information provider, defaults to `https://ifconfig.co/`.
 - **rate_limit_burst** (Number) Limit the number of the request to the IP information provider. Defines the number of events per rate until the limit is reached. Defaults to `1`.
 - **rate_limit_rate** (String) Limit the number of the request to the IP information provider. Defines the time until the limit is reset. Defaults to `500ms`.
 - **timeout** (String) Timeout of the request to the IP information provider. Defaults to `5s`.

…s/data-sources/ip_address/data-source.tf …-sources/publicip_address/data-source.tfexamples/data-sources/ip_address/data-source.tf renamed to examples/data-sources/publicip_address/data-source.tf examples/data-sources/ip_address/data-source.tf renamed to examples/data-sources/publicip_address/data-source.tf

@@ -1,3 +1,8 @@
 provider "publicip" {
-  provider_url = "https://ifconfig.co/" # default value
+  provider_url = "https://ifconfig.co/" # optional
+  timeout      = "10s"                  # optional
+
+  # 1 request per 500ms
+  rate_limit_rate  = "500ms" # optional
+  rate_limit_burst = "1"     # optional
 }

examples/provider/provider.tf

@@ -30,7 +30,7 @@ func (t ipDataSourceType) GetSchema(_ context.Context) (tfsdk.Schema, diag.Diagn
 				Type:                types.StringType,
 			},
 			"ip_version": {
-				MarkdownDescription: "Whether to use IPv4 or IPv6 only. Valid values: 'V4', 'V6'",
+				MarkdownDescription: fmt.Sprintf("Whether to use IPv4 or IPv6 only. Valid values: '%s', '%s'", IPVersion6, IPVersion4),
 				Optional:            true,
 				Type:                types.StringType,
 				Validators:          []tfsdk.AttributeValidator{ipVersionValidator{}},

internal/provider/ip_address_data_source.go

@@ -161,7 +161,7 @@ func (p *provider) GetSchema(_ context.Context) (tfsdk.Schema, diag.Diagnostics)
 				Type:                types.Int64Type,
 			},
 			"provider_url": {
-				MarkdownDescription: fmt.Sprintf("URL to a ifconfig.co-compatible IP information provider, defaults to `%s`.", DefaultProviderURL),
+				MarkdownDescription: fmt.Sprintf("URL to an ifconfig.co-compatible IP information provider, defaults to `%s`.", DefaultProviderURL),
 				Optional:            true,
 				Type:                types.StringType,
 			},