Merge pull request #40246 from Calinou/doc-httprequest-post-example

Add a POST request example to the HTTPRequest class documentation

1 files changed, 9 insertions, 1 deletions

diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml
index 53ca1fc6a9..0b0d71fccf 100644
--- a/doc/classes/HTTPRequest.xml
+++ b/doc/classes/HTTPRequest.xml
@@ -14,11 +14,19 @@
 		    add_child(http_request)
 		    http_request.connect("request_completed", self, "_http_request_completed")
 
-		    # Perform the HTTP request. The URL below returns some JSON as of writing.
+		    # Perform a GET request. The URL below returns JSON as of writing.
 		    var error = http_request.request("https://httpbin.org/get")
 		    if error != OK:
 		        push_error("An error occurred in the HTTP request.")
 
+		    # Perform a POST request. The URL below returns JSON as of writing.
+		    # Note: Don't make simultaneous requests using a single HTTPRequest node.
+		    # The snippet below is provided for reference only.
+		    var body = {"name": "Godette"}
+		    var error = http_request.request("https://httpbin.org/post", [], true, HTTPClient.METHOD_POST, body)
+		    if error != OK:
+		        push_error("An error occurred in the HTTP request.")
+
 
 		# Called when the HTTP request is completed.
 		func _http_request_completed(result, response_code, headers, body):