DOC: http: rename the unique-id sample and add the documentation

This patch renames the ssample fetch from "uniqueid" to "unique-id".
It also adds the documentation associated with this sample fetch.

diff --git a/doc/configuration.txt b/doc/configuration.txt
index 6b80158457e284aa06996c55ca9e2f77b58b56cb..9798f32ca93f1a3cb49b668ecf737f74cbcacc4c 100644 (file)
--- a/doc/configuration.txt
+++ b/doc/configuration.txt
@@ -13900,6 +13900,14 @@ status : integer
   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.
 
+unique-id : string
+  Returns the unique-id attached to the request. The directive
+  "unique-id-format" must be set. If it is not set, the unique-id sample fetch
+  fails. Note that the unique-id is usually used with HTTP requests, however this
+  sample fetch can be used with other protocols. Obviously, if it is used with
+  other protocols than HTTP, the unique-id-format directive must not contain
+  HTTP parts. See: unique-id-format and unique-id-header
+
 url : string
   This extracts the request's URL as presented in the request. A typical use is
   with prefetch-capable caches, and with portals which need to aggregate

diff --git a/src/proto_http.c b/src/proto_http.c
index 6ab14ce7b5cab577b631b843dd8ba772b909f0e9..82d4b8700611459d028e2f2a50774adc7ade9d51 100644 (file)
--- a/src/proto_http.c
+++ b/src/proto_http.c
@@ -12817,7 +12817,7 @@ static struct sample_fetch_kw_list sample_fetch_keywords = {ILH, {
        { "shdr_val",        smp_fetch_hdr_val,        ARG2(0,STR,SINT), val_hdr, SMP_T_SINT, SMP_USE_HRSHV },
 
        { "status",          smp_fetch_stcode,         0,                NULL,    SMP_T_SINT, SMP_USE_HRSHP },
-       { "uniqueid",        smp_fetch_uniqueid,       0,                NULL,    SMP_T_STR,  SMP_SRC_L4SRV },
+       { "unique-id",       smp_fetch_uniqueid,       0,                NULL,    SMP_T_STR,  SMP_SRC_L4SRV },
        { "url",             smp_fetch_url,            0,                NULL,    SMP_T_STR,  SMP_USE_HRQHV },
        { "url32",           smp_fetch_url32,          0,                NULL,    SMP_T_SINT, SMP_USE_HRQHV },
        { "url32+src",       smp_fetch_url32_src,      0,                NULL,    SMP_T_BIN,  SMP_USE_HRQHV },