comparison 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
comparison
equal deleted inserted replaced
6538:28fa3798ca3d 6539:f8df7fed18f6
225 225
226 Performing a ``GET`` on an item or property of an item will return an 226 Performing a ``GET`` on an item or property of an item will return an
227 ETag header or an @etag property. This needs to be submitted with 227 ETag header or an @etag property. This needs to be submitted with
228 ``DELETE``, ``PUT`` and ``PATCH`` operations on the item using an 228 ``DELETE``, ``PUT`` and ``PATCH`` operations on the item using an
229 ``If-Match`` header or an ``"@etag`` property in the data payload if 229 ``If-Match`` header or an ``"@etag`` property in the data payload if
230 the method supports a payload. 230 the method supports a payload. The ETag header value will include a
231 suffix (starting with '-') indicating the Content-Encoding used to
232 respond to the request. If the response was uncompressed, there will
233 be no suffix. The ``@etag`` property never includes the suffix. Any
234 ETag value suffixed or not can be sent in an ``If-Match`` header as
235 the suffix is ignored during comparison.
231 236
232 The exact details of returned data is determined by the value of the 237 The exact details of returned data is determined by the value of the
233 ``@verbose`` query parameter. The various supported values and their 238 ``@verbose`` query parameter. The various supported values and their
234 effects are described in the following sections. 239 effects are described in the following sections.
235 240

Roundup Issue Tracker: http://roundup-tracker.org/