Updating docs to include examples of HEAD and POST requests (hashicor…

…p#179) (hashicorp#180)
opentofu · Aug 24, 2022 · dcf674f · dcf674f
1 parent f0b19bf
commit dcf674f
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/docs/data-sources/http.md b/docs/data-sources/http.md
@@ -42,6 +42,22 @@ data "http" "example" {
     Accept = "application/json"
   }
 }
+
+# The following example shows how to issue an HTTP HEAD request.
+data "http" "example_head" {
+  url    = "https://checkpoint-api.hashicorp.com/v1/check/terraform"
+  method = "HEAD"
+}
+
+# The following example shows how to issue an HTTP POST request
+# supplying an optional request body.
+data "http" "example_post" {
+  url    = "https://checkpoint-api.hashicorp.com/v1/check/terraform"
+  method = "POST"
+
+  # Optional request body
+  request_body = "request body"
+}
 ```
 
 ## Usage with Postcondition

diff --git a/examples/data-sources/http/data-source.tf b/examples/data-sources/http/data-source.tf
@@ -8,3 +8,19 @@ data "http" "example" {
     Accept = "application/json"
   }
 }
+
+# The following example shows how to issue an HTTP HEAD request.
+data "http" "example_head" {
+  url    = "https://checkpoint-api.hashicorp.com/v1/check/terraform"
+  method = "HEAD"
+}
+
+# The following example shows how to issue an HTTP POST request
+# supplying an optional request body.
+data "http" "example_post" {
+  url    = "https://checkpoint-api.hashicorp.com/v1/check/terraform"
+  method = "POST"
+
+  # Optional request body
+  request_body = "request body"
+}