diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2021-09-03 16:42:29 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-03 16:42:29 +0200 |
| commit | c3591a9b04f3cc62d5ea4fe13228979b0200cce3 (patch) | |
| tree | 6012c8091be0b858f638b5607136b6d6de369e00 /doc/classes | |
| parent | 2cece71b69a0f621199e175a2956855f0f1777c8 (diff) | |
| parent | 1ed3d9a0b0a0a69070af59eee4325f69c4302dc7 (diff) | |
Merge pull request #52368 from arthurpaulino/remove-http-request-data-note
Inaccurate HTTPRequest documentation node
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/HTTPRequest.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index f45ddd0abb..4fafa0a0a1 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -192,7 +192,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.uri_encode] for an example. + [b]Note:[/b] When [code]method[/code] is [constant HTTPClient.METHOD_GET], the payload sent via [code]request_data[/code] might be ignored by the server or even cause the server to reject the request (check [url=https://datatracker.ietf.org/doc/html/rfc7231#section-4.3.1]RFC 7231 section 4.3.1[/url] for more details). As a workaround, you can send data as a query string in the URL. See [method String.uri_encode] for an example. </description> </method> <method name="request_raw"> |