DOC: lua: add a note about compression w/ httpclient

Decompression is not supported by the httpclient.

diff --git a/doc/lua-api/index.rst b/doc/lua-api/index.rst
index b76cb09e2bf28c7083a70d7b1dc7def1a5324f05..072b56b066feb573647fbcaa163b44836a23aa4a 100644 (file)
--- a/doc/lua-api/index.rst
+++ b/doc/lua-api/index.rst
@@ -1865,6 +1865,9 @@ HTTPClient class
   Send a HTTP request and wait for a response. GET, HEAD PUT, POST and DELETE methods can be used.
   The HTTPClient will send asynchronously the data and is able to send and receive more than HAProxy bufsize.
 
+  The HTTPClient interface is not able to decompress responses, it is not
+  recommended to send an Accept-Encoding in the request so the response is
+  received uncompressed.
 
   :param class httpclient: Is the manipulated HTTPClient.
   :param table request: Is a table containing the parameters of the request that will be send.