From 8e1cb396cf86603397ff64c7e59d2d17ecd9dfc8 Mon Sep 17 00:00:00 2001 From: Brendan Abolivier Date: Fri, 29 Jul 2022 11:09:57 +0200 Subject: [PATCH] Explicitly mention which resources support compression in the config guide (#13221) --- changelog.d/13221.doc | 1 + docs/usage/configuration/config_documentation.md | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) create mode 100644 changelog.d/13221.doc diff --git a/changelog.d/13221.doc b/changelog.d/13221.doc new file mode 100644 index 000000000000..dd2b3d897232 --- /dev/null +++ b/changelog.d/13221.doc @@ -0,0 +1 @@ +Document which HTTP resources support gzip compression. diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index d8616f7dbda1..6f8d7b7d26cd 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -486,7 +486,8 @@ Sub-options for each listener include: * `names`: a list of names of HTTP resources. See below for a list of valid resource names. - * `compress`: set to true to enable HTTP compression for this resource. + * `compress`: set to true to enable gzip compression on HTTP bodies for this resource. This is currently only supported with the + `client`, `consent` and `metrics` resources. * `additional_resources`: Only valid for an 'http' listener. A map of additional endpoints which should be loaded via dynamic modules.