chore: gen docs

hashicorp · Mar 15, 2024 · c595358 · c595358
1 parent baa9ac0
commit c595358
Show file tree

Hide file tree

Showing 20 changed files with 173 additions and 79 deletions.
diff --git a/docs/functions/equal.md b/docs/functions/equal.md
@@ -0,0 +1,27 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "equal function - assert"
+subcategory: ""
+description: |-
+  Checks whether a number is equal to a given number
+---
+
+# function: equal
+
+
+
+
+
+## Signature
+
+<!-- signature generated by tfplugindocs -->
+```text
+equal(number number, compare_against number) bool
+```
+
+## Arguments
+
+<!-- arguments generated by tfplugindocs -->
+1. `number` (Number, Nullable) The number to check
+1. `compare_against` (Number) The number to compare against
+
diff --git a/docs/functions/greater_than.md b/docs/functions/greater_than.md
@@ -0,0 +1,27 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "greater_than function - assert"
+subcategory: ""
+description: |-
+  Checks whether a number is greater than a given number
+---
+
+# function: greater_than
+
+
+
+
+
+## Signature
+
+<!-- signature generated by tfplugindocs -->
+```text
+greater_than(number number, compare_against number) bool
+```
+
+## Arguments
+
+<!-- arguments generated by tfplugindocs -->
+1. `number` (Number, Nullable) The number to check
+1. `compare_against` (Number) The number to compare against
+
diff --git a/docs/functions/greater_than_or_equal.md b/docs/functions/greater_than_or_equal.md
@@ -0,0 +1,27 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "greater_than_or_equal function - assert"
+subcategory: ""
+description: |-
+  Checks whether a number is greater than or equal to a given number
+---
+
+# function: greater_than_or_equal
+
+
+
+
+
+## Signature
+
+<!-- signature generated by tfplugindocs -->
+```text
+greater_than_or_equal(number number, compare_against number) bool
+```
+
+## Arguments
+
+<!-- arguments generated by tfplugindocs -->
+1. `number` (Number, Nullable) The number to check
+1. `compare_against` (Number) The number to compare against
+
diff --git a/docs/functions/is_http_4xx.md → docs/functions/http_client_error.md b/docs/functions/is_http_4xx.md → docs/functions/http_client_error.md
@@ -1,9 +1,9 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "http_client_error function - terraform-provider-assert"
+page_title: "http_client_error function - assert"
 subcategory: ""
 description: |-
-  Checks whether the HTTP status code is a valid 4xx status code
+  Checks whether an HTTP status code is a client error status code
 ---
 
 # function: http_client_error

diff --git a/docs/functions/is_http_3xx.md → docs/functions/http_redirect.md b/docs/functions/is_http_3xx.md → docs/functions/http_redirect.md
@@ -1,9 +1,9 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "http_redirect function - terraform-provider-assert"
+page_title: "http_redirect function - assert"
 subcategory: ""
 description: |-
-  Checks whether the HTTP status code is a valid 3xx status code
+  Checks whether an HTTP status code is a redirect status code
 ---
 
 # function: http_redirect

diff --git a/docs/functions/is_http_5xx.md → docs/functions/http_server_error.md b/docs/functions/is_http_5xx.md → docs/functions/http_server_error.md
@@ -1,9 +1,9 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "http_server_error function - terraform-provider-assert"
+page_title: "http_server_error function - assert"
 subcategory: ""
 description: |-
-  Checks whether the HTTP status code is a valid 5xx status code
+  Checks whether an HTTP status code is a server error status code
 ---
 
 # function: http_server_error

diff --git a/docs/functions/is_http_2xx.md → docs/functions/http_success.md b/docs/functions/is_http_2xx.md → docs/functions/http_success.md
@@ -1,9 +1,9 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "http_success function - terraform-provider-assert"
+page_title: "http_success function - assert"
 subcategory: ""
 description: |-
-  Checks whether the HTTP status code is a valid 2xx status code
+  Checks whether an HTTP status code is a success status code
 ---
 
 # function: http_success

diff --git a/docs/functions/less_than.md b/docs/functions/less_than.md
@@ -0,0 +1,27 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "less_than function - assert"
+subcategory: ""
+description: |-
+  Checks whether a number is less than a given number
+---
+
+# function: less_than
+
+
+
+
+
+## Signature
+
+<!-- signature generated by tfplugindocs -->
+```text
+less_than(number number, compare_against number) bool
+```
+
+## Arguments
+
+<!-- arguments generated by tfplugindocs -->
+1. `number` (Number, Nullable) The number to check
+1. `compare_against` (Number) The number to compare against
+
diff --git a/docs/functions/less_than_or_equal.md b/docs/functions/less_than_or_equal.md
@@ -0,0 +1,27 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "less_than_or_equal function - assert"
+subcategory: ""
+description: |-
+  Checks whether a number is less than or equal to a given number
+---
+
+# function: less_than_or_equal
+
+
+
+
+
+## Signature
+
+<!-- signature generated by tfplugindocs -->
+```text
+less_than_or_equal(number number, compare_against number) bool
+```
+
+## Arguments
+
+<!-- arguments generated by tfplugindocs -->
+1. `number` (Number, Nullable) The number to check
+1. `compare_against` (Number) The number to compare against
+
diff --git a/docs/functions/not_equal.md b/docs/functions/not_equal.md
@@ -0,0 +1,27 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "not_equal function - assert"
+subcategory: ""
+description: |-
+  Checks whether a number is not equal to a given number
+---
+
+# function: not_equal
+
+
+
+
+
+## Signature
+
+<!-- signature generated by tfplugindocs -->
+```text
+not_equal(number number, compare_against number) bool
+```
+
+## Arguments
+
+<!-- arguments generated by tfplugindocs -->
+1. `number` (Number, Nullable) The number to check
+1. `compare_against` (Number) The number to compare against
+
diff --git a/docs/functions/not_null.md b/docs/functions/not_null.md
@@ -1,6 +1,6 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "not_null function - terraform-provider-assert"
+page_title: "not_null function - assert"
 subcategory: ""
 description: |-
   Checks whether a given object is not null

diff --git a/docs/functions/is_null.md → docs/functions/null.md b/docs/functions/is_null.md → docs/functions/null.md
@@ -1,6 +1,6 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "null function - terraform-provider-assert"
+page_title: "null function - assert"
 subcategory: ""
 description: |-
   Checks whether a given object is null

diff --git a/docs/functions/within_range.md b/docs/functions/within_range.md
@@ -1,6 +1,6 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "within_range function - terraform-provider-assert"
+page_title: "within_range function - assert"
 subcategory: ""
 description: |-
   Checks whether a number is within a given range

diff --git a/examples/functions/is_http_2xx/example.tf b/examples/functions/is_http_2xx/example.tf
diff --git a/examples/functions/is_http_3xx/example.tf b/examples/functions/is_http_3xx/example.tf
diff --git a/examples/functions/is_http_4xx/example.tf b/examples/functions/is_http_4xx/example.tf
diff --git a/examples/functions/is_http_5xx/example.tf b/examples/functions/is_http_5xx/example.tf
diff --git a/examples/functions/is_null/example.tf b/examples/functions/is_null/example.tf
diff --git a/examples/functions/not_null/example.tf b/examples/functions/not_null/example.tf
diff --git a/examples/functions/within_range/example.tf b/examples/functions/within_range/example.tf