diff --git a/docs/functions/equal.md b/docs/functions/equal.md new file mode 100644 index 0000000..73a4eae --- /dev/null +++ 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 + + +```text +equal(number number, compare_against number) bool +``` + +## Arguments + + +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 new file mode 100644 index 0000000..5355340 --- /dev/null +++ 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 + + +```text +greater_than(number number, compare_against number) bool +``` + +## Arguments + + +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 new file mode 100644 index 0000000..5c27032 --- /dev/null +++ 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 + + +```text +greater_than_or_equal(number number, compare_against number) bool +``` + +## Arguments + + +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 b/docs/functions/http_client_error.md similarity index 73% rename from docs/functions/is_http_4xx.md rename to docs/functions/http_client_error.md index 7d0c052..862f372 100644 --- a/docs/functions/is_http_4xx.md +++ b/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 b/docs/functions/http_redirect.md similarity index 73% rename from docs/functions/is_http_3xx.md rename to docs/functions/http_redirect.md index cb3e8bb..8d42293 100644 --- a/docs/functions/is_http_3xx.md +++ b/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 b/docs/functions/http_server_error.md similarity index 73% rename from docs/functions/is_http_5xx.md rename to docs/functions/http_server_error.md index fcfc164..7636c18 100644 --- a/docs/functions/is_http_5xx.md +++ b/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 b/docs/functions/http_success.md similarity index 73% rename from docs/functions/is_http_2xx.md rename to docs/functions/http_success.md index 5739fc3..d0a2f6a 100644 --- a/docs/functions/is_http_2xx.md +++ b/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 new file mode 100644 index 0000000..f25fdac --- /dev/null +++ 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 + + +```text +less_than(number number, compare_against number) bool +``` + +## Arguments + + +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 new file mode 100644 index 0000000..4038ef4 --- /dev/null +++ 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 + + +```text +less_than_or_equal(number number, compare_against number) bool +``` + +## Arguments + + +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 new file mode 100644 index 0000000..aef09c6 --- /dev/null +++ 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 + + +```text +not_equal(number number, compare_against number) bool +``` + +## Arguments + + +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 index cc6b55f..2398bcb 100644 --- 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 b/docs/functions/null.md similarity index 87% rename from docs/functions/is_null.md rename to docs/functions/null.md index 248fd7e..b4f9ec4 100644 --- a/docs/functions/is_null.md +++ b/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 index ea258ed..92ee572 100644 --- 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 deleted file mode 100644 index 21840d8..0000000 --- a/examples/functions/is_http_2xx/example.tf +++ /dev/null @@ -1,12 +0,0 @@ -data "http" "example" { - url = "https://checkpoint-api.hashicorp.com/v1/check/terraform" - - # Optional request headers - request_headers = { - Accept = "application/json" - } -} - -output "http_success" { - value = provider::assert::http_success(data.http.example.status_code) -} diff --git a/examples/functions/is_http_3xx/example.tf b/examples/functions/is_http_3xx/example.tf deleted file mode 100644 index 3d4d3cb..0000000 --- a/examples/functions/is_http_3xx/example.tf +++ /dev/null @@ -1,12 +0,0 @@ -data "http" "example" { - url = "https://checkpoint-api.hashicorp.com/v1/check/terraform" - - # Optional request headers - request_headers = { - Accept = "application/json" - } -} - -output "http_redirect" { - value = provider::assert::http_redirect(data.http.example.status_code) -} diff --git a/examples/functions/is_http_4xx/example.tf b/examples/functions/is_http_4xx/example.tf deleted file mode 100644 index 92fb5c2..0000000 --- a/examples/functions/is_http_4xx/example.tf +++ /dev/null @@ -1,12 +0,0 @@ -data "http" "example" { - url = "https://checkpoint-api.hashicorp.com/v1/check/terraform" - - # Optional request headers - request_headers = { - Accept = "application/json" - } -} - -output "http_client_error" { - value = provider::assert::http_client_error(data.http.example.status_code) -} diff --git a/examples/functions/is_http_5xx/example.tf b/examples/functions/is_http_5xx/example.tf deleted file mode 100644 index ce1bfce..0000000 --- a/examples/functions/is_http_5xx/example.tf +++ /dev/null @@ -1,12 +0,0 @@ -data "http" "example" { - url = "https://checkpoint-api.hashicorp.com/v1/check/terraform" - - # Optional request headers - request_headers = { - Accept = "application/json" - } -} - -output "http_server_error" { - value = provider::assert::http_server_error(data.http.example.status_code) -} diff --git a/examples/functions/is_null/example.tf b/examples/functions/is_null/example.tf deleted file mode 100644 index 1b37d05..0000000 --- a/examples/functions/is_null/example.tf +++ /dev/null @@ -1,7 +0,0 @@ -locals { - person = null -} - -output "null" { - value = provider::assert::null(local.person) -} diff --git a/examples/functions/not_null/example.tf b/examples/functions/not_null/example.tf deleted file mode 100644 index d607d00..0000000 --- a/examples/functions/not_null/example.tf +++ /dev/null @@ -1,10 +0,0 @@ -locals { - person = { - name = "John Doe" - age = 30 - } -} - -output "example" { - value = provider::assert::not_null(local.person) -} diff --git a/examples/functions/within_range/example.tf b/examples/functions/within_range/example.tf deleted file mode 100644 index 0502eab..0000000 --- a/examples/functions/within_range/example.tf +++ /dev/null @@ -1,3 +0,0 @@ -output "example" { - value = provider::assert::within_range(1, 10, 4) -}