From 4a9dc1d6c1f3dfe56737f482becdfe465189d444 Mon Sep 17 00:00:00 2001
From: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Mon, 20 Nov 2023 15:08:44 +0200
Subject: [PATCH] docs: http client docs

---
 CHANGELOG.md         |  4 ++++
 openapi/CHANGELOG.md | 12 ++++++++++++
 openapi/openapi.yaml | 19 +++++++++++++++++++
 3 files changed, 35 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index ac65bf5f..04f61734 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -25,6 +25,7 @@ NOTE: Add new changes BELOW THIS COMMENT.
 
 ### Added
 
+- Ability to set client's custom DNS cache ([#6362], [dnsproxy#169]).
 - Ability to specify rate limiting settings in the Web UI ([#6369]).
 
 #### Configuration changes
@@ -40,9 +41,12 @@ NOTE: Add new changes BELOW THIS COMMENT.
 - Protection pause timer synchronization ([#5759]).
 
 [#5759]: https://github.com/AdguardTeam/AdGuardHome/issues/5759
+[#6362]: https://github.com/AdguardTeam/AdGuardHome/issues/6362
 [#6369]: https://github.com/AdguardTeam/AdGuardHome/issues/6369
 [#6402]: https://github.com/AdguardTeam/AdGuardHome/issues/6402
 
+[dnsproxy#169] https://github.com/AdguardTeam/dnsproxy/issues/169
+
 <!--
 NOTE: Add new changes ABOVE THIS COMMENT.
 -->
diff --git a/openapi/CHANGELOG.md b/openapi/CHANGELOG.md
index 41747529..16e7ab0d 100644
--- a/openapi/CHANGELOG.md
+++ b/openapi/CHANGELOG.md
@@ -6,6 +6,18 @@
 
 ## v0.107.42: API changes
 
+### The new fields `"upstreams_cache_enabled"` and `"upstreams_cache_size"` in `Client` object
+
+* The new field `"upstreams_cache_enabled"` in `GET /control/clients`,
+  `GET /control/clients/find`, `POST /control/clients/add`, and
+  `POST /control/clients/update` methods shows if client's DNS cache is enabled
+  for the client.  If not set AdGuard Home will use default value (false).
+
+* The new field `"upstreams_cache_size"` in `GET /control/clients`,
+  `GET /control/clients/find`, `POST /control/clients/add`, and
+  `POST /control/clients/update` methods is the size of client's DNS cache in
+  bytes.
+
 ### The new field `"ratelimit_subnet_len_ipv4"` in `DNSConfig` object
 
 * The new field `"ratelimit_subnet_len_ipv4"` in `GET /control/dns_info` and
diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml
index 2c225ea6..c105ee1d 100644
--- a/openapi/openapi.yaml
+++ b/openapi/openapi.yaml
@@ -2684,6 +2684,25 @@
             If `ignore_statistics` is not set in HTTP API `GET /clients/update`
             request then the existing value will not be changed.
 
+            This behaviour can be changed in the future versions.
+          'type': 'boolean'
+        'upstreams_cache_enabled':
+          'description': |
+            NOTE: If `upstreams_cache_enabled` is not set in HTTP API
+            `GET /clients/add` request then default value (false) will be used.
+
+            If `upstreams_cache_enabled` is not set in HTTP API
+            `GET /clients/update` request then the existing value will not be
+            changed.
+
+            This behaviour can be changed in the future versions.
+          'type': 'boolean'
+        'upstreams_cache_size':
+          'description': |
+            NOTE: If `upstreams_cache_enabled` is not set in HTTP API
+            `GET /clients/update` request then the existing value will not be
+            changed.
+
             This behaviour can be changed in the future versions.
           'type': 'boolean'
     'ClientAuto':