Mercurial > p > roundup > code
diff doc/rest.txt @ 6539:f8df7fed18f6
issue2551175 - Make ETag content-encoding aware.
HTTP ETag headers now include a suffix (-gzip, -br, -zstd) indicating
the content-encoding used to send the data per rfc7232. Validate any
form of ETag by stripping a suffix (if present).
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Wed, 01 Dec 2021 19:52:54 -0500 |
| parents | 22cf6ee7ad88 |
| children | 24e2eeb2ed9a |
line wrap: on
line diff
--- a/doc/rest.txt Tue Nov 30 00:21:55 2021 -0500 +++ b/doc/rest.txt Wed Dec 01 19:52:54 2021 -0500 @@ -227,7 +227,12 @@ ETag header or an @etag property. This needs to be submitted with ``DELETE``, ``PUT`` and ``PATCH`` operations on the item using an ``If-Match`` header or an ``"@etag`` property in the data payload if -the method supports a payload. +the method supports a payload. The ETag header value will include a +suffix (starting with '-') indicating the Content-Encoding used to +respond to the request. If the response was uncompressed, there will +be no suffix. The ``@etag`` property never includes the suffix. Any +ETag value suffixed or not can be sent in an ``If-Match`` header as +the suffix is ignored during comparison. The exact details of returned data is determined by the value of the ``@verbose`` query parameter. The various supported values and their