nick/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-02-24 12:50:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document HTTPRequest not supporting request data with GET method

Browse Source 
This also improves the HTTPClient class documentation to be easier
to read and more informative.

This closes #40564.
This commit is contained in:
Hugo Locurcio
2020-08-03 14:56:53 +02:00
parent 9adf6d3441
commit 2f577facc9
2 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc/classes/HTTPRequest.xml
View File

@@ -116,6 +116,7 @@
<description>
Creates request on the underlying [HTTPClient]. If there is no configuration errors, it tries to connect using [method HTTPClient.connect_to_host] and passes parameters onto [method HTTPClient.request].
Returns [constant OK] if request is successfully created. (Does not imply that the server has responded), [constant ERR_UNCONFIGURED] if not in the tree, [constant ERR_BUSY] if still processing previous request, [constant ERR_INVALID_PARAMETER] if given string is not a valid URL format, or [constant ERR_CANT_CONNECT] if not using thread and the [HTTPClient] cannot connect to host.
[b]Note:[/b] The [code]request_data[/code] parameter is ignored if [code]method[/code] is [constant HTTPClient.METHOD_GET]. This is because GET methods can't contain request data. As a workaround, you can pass request data as a query string in the URL. See [method String.http_escape] for an example.
</description>
</method>
</methods>