make generate

bschaatsbergen · Apr 4, 2024 · 7176493 · 7176493
1 parent ed45947
commit 7176493
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 6 deletions.
diff --git a/docs/functions/ip.md b/docs/functions/ip.md
@@ -1,5 +1,4 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "ip function - terraform-provider-assert"
 subcategory: ""
 description: |-
@@ -10,7 +9,7 @@ description: |-
 
 
 
-## Example Usage
+## Terraform Test Example
 
 ```terraform
 run "check_valid_ip_google_compute_address" {
@@ -24,6 +23,18 @@ run "check_valid_ip_google_compute_address" {
 }
 ```
 
+## Variable Validation Example
+
+```terraform
+variable "ip_address" {
+  type = number
+  validation {
+    condition     = provider::assert::ip(var.ip_address)
+    error_message = "Invalid IP address"
+  }
+}
+```
+
 ## Signature
 
 <!-- signature generated by tfplugindocs -->
@@ -36,3 +47,7 @@ ip(ip_address string) bool
 <!-- arguments generated by tfplugindocs -->
 1. `ip_address` (String) The string to check
 
+
+## Return Type
+
+The return type of `ip` is a boolean.
diff --git a/docs/functions/ipv4.md b/docs/functions/ipv4.md
@@ -1,5 +1,4 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "ipv4 function - terraform-provider-assert"
 subcategory: ""
 description: |-
@@ -10,7 +9,7 @@ description: |-
 
 
 
-## Example Usage
+## Terraform Test Example
 
 ```terraform
 run "check_valid_ipv4_google_compute_address" {
@@ -24,6 +23,18 @@ run "check_valid_ipv4_google_compute_address" {
 }
 ```
 
+## Variable Validation Example
+
+```terraform
+variable "ipv4_address" {
+  type = number
+  validation {
+    condition     = provider::assert::ipv4(var.ipv4_address)
+    error_message = "Invalid IPv4 address"
+  }
+}
+```
+
 ## Signature
 
 <!-- signature generated by tfplugindocs -->
@@ -36,3 +47,7 @@ ipv4(ip_address string) bool
 <!-- arguments generated by tfplugindocs -->
 1. `ip_address` (String) The string to check
 
+
+## Return Type
+
+The return type of `ipv4` is a boolean.
diff --git a/docs/functions/ipv6.md b/docs/functions/ipv6.md
@@ -1,5 +1,4 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "ipv6 function - terraform-provider-assert"
 subcategory: ""
 description: |-
@@ -10,7 +9,7 @@ description: |-
 
 
 
-## Example Usage
+## Terraform Test Example
 
 ```terraform
 run "check_valid_ipv6_google_compute_address" {
@@ -24,6 +23,18 @@ run "check_valid_ipv6_google_compute_address" {
 }
 ```
 
+## Variable Validation Example
+
+```terraform
+variable "ipv6_address" {
+  type = number
+  validation {
+    condition     = provider::assert::ipv6(var.ipv6_address)
+    error_message = "Invalid IPv6 address"
+  }
+}
+```
+
 ## Signature
 
 <!-- signature generated by tfplugindocs -->
@@ -36,3 +47,7 @@ ipv6(ip_address string) bool
 <!-- arguments generated by tfplugindocs -->
 1. `ip_address` (String) The string to check
 
+
+## Return Type
+
+The return type of `ipv6` is a boolean.
diff --git a/templates/functions/ip.tmpl → templates/functions/ip.md.tmpl b/templates/functions/ip.tmpl → templates/functions/ip.md.tmpl
diff --git a/templates/functions/ipv4.tmpl → templates/functions/ipv4.md.tmpl b/templates/functions/ipv4.tmpl → templates/functions/ipv4.md.tmpl
diff --git a/templates/functions/ipv6.tmpl → templates/functions/ipv6.md.tmpl b/templates/functions/ipv6.tmpl → templates/functions/ipv6.md.tmpl