From 9690f262542d0ea10d957937abd375624fba8df4 Mon Sep 17 00:00:00 2001 From: Tronje Krop Date: Thu, 20 Jul 2023 14:21:17 +0200 Subject: [PATCH] Apply suggestions from code review (#769) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Paŭlo Ebermann --- chapters/performance.adoc | 2 +- models/headers-1.0.0.yaml | 22 +++++++++++----------- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/chapters/performance.adoc b/chapters/performance.adoc index e6953953..f091f1de 100644 --- a/chapters/performance.adoc +++ b/chapters/performance.adoc @@ -43,7 +43,7 @@ unencoded content for testing. This is ensured by content negotiation using the {Accept-Encoding} request header (see {RFC-9110}#section-12.5.3[RFC 9110 Section 12.5.3]). Successful compression is signaled via the {Content-Encoding} response header (see {RFC-9110}#section-8.4[RFC 9110 Section 8.4]). Clients and -servers may support other compression algorithms as `compress`, `deflate`, or +servers may support other compression formats as `compress`, `deflate`, or `br`. To signal server support for compression the API specification should define diff --git a/models/headers-1.0.0.yaml b/models/headers-1.0.0.yaml index c1c57847..243b73cd 100644 --- a/models/headers-1.0.0.yaml +++ b/models/headers-1.0.0.yaml @@ -13,12 +13,12 @@ Accept-Encoding: Supported compression algorithms of the server are [**gzip**][gzip] and **identity**, but other encodings from list below may be support too: - * **gzip** - a compression format that uses [Lempel-Ziv coding][gzip] - (LZ77) with a 32-bit CRC. - * **compress** - a format using the [Lempel-Ziv-Welch][lzw] (LZW) - algorithm. + * **gzip** - a[compression format with the [gzip file format][gzip] + (including a 32 bit CRC) around the [deflate][deflate] compression algorithm. * **deflate** - A compression format that uses the [zlib][zlib] structure with the [deflate][deflate] compression algorithm. + * **compress** - a format using the [Lempel-Ziv-Welch][lzw] (LZW) + algorithm. * **br** - a compression format that uses the [Brotli][brotli] algorithm. * **identity** - the identity function without modification or compression used to indicate unchanged responses. This value is always considered as @@ -38,7 +38,7 @@ Accept-Encoding: [rfc-9110-12.5.3]: [api-156]: - [gzip]: + [gzip]: [lzw]: [zlib]: [deflate]: @@ -183,15 +183,15 @@ Content-Encoding: the recipient to decode the content in order to obtain the original payload format. - Supported compression algorithms of the server are [**gzip**][gzip] and + Always supported compression algorithms of the server are [**gzip**][gzip] and **identity**, but other encoding from list below may be support too: - * **gzip** - a compression format that uses [Lempel-Ziv coding][gzip] - (LZ77) with a 32-bit CRC. - * **compress** - a format using the [Lempel-Ziv-Welch][lzw] (LZW) - algorithm. + * **gzip** - a[compression format with the [gzip file format][gzip] + (including a 32 bit CRC) around the [deflate][deflate] compression algorithm. * **deflate** - A compression format that uses the [zlib][zlib] structure with the [deflate][deflate] compression algorithm. + * **compress** - a format using the [Lempel-Ziv-Welch][lzw] (LZW) + algorithm. * **br** - a compression format that uses the [Brotli][brotli] algorithm. * **identity** - the identity function without modification or compression used to indicate unchanged responses. This value is always considered as @@ -208,7 +208,7 @@ Content-Encoding: [rfc-9110-8.4]: [api-156]: - [gzip]: + [gzip]: [lzw]: [zlib]: [deflate]: