]> git.ipfire.org Git - thirdparty/haproxy.git/commitdiff
DOC: config: Improve 'status' sample documentation
authorChristopher Faulet <cfaulet@haproxy.com>
Mon, 27 Nov 2023 17:27:47 +0000 (18:27 +0100)
committerChristopher Faulet <cfaulet@haproxy.com>
Wed, 29 Nov 2023 10:11:12 +0000 (11:11 +0100)
We clearly state the 'status' sample returns the status code the client will
receive, if no change happens on the HTTP response. This should avoid
ambiguities with the 'server-status' sample fetch.

doc/configuration.txt

index 76647e5e3ce9bf22753ca06b04f69391170ed082..b4827e00f5b2cea335773c875ab95130b8572aac 100644 (file)
@@ -22838,7 +22838,9 @@ set-cookie([<name>]) : string (deprecated)
 status : integer
   Returns an integer containing the HTTP status code in the HTTP response, for
   example, 302. It is mostly used within ACLs and integer ranges, for example,
-  to remove any Location header if the response is not a 3xx.
+  to remove any Location header if the response is not a 3xx. It will be the
+  status code received by the client if it is not changed, via a 'set-status'
+  action for instance.
 
   It may be used in tcp-check based expect rules.