Merge pull request #225 from AdguardTeam/fixes-to-adguard-dns-api

el-termikael · web-flow · commit b73663a1c672 · 2024-08-12T12:47:45.000+03:00
various fixes to AG DNS API
diff --git a/docs/adguard-home/overview.md b/docs/adguard-home/overview.md
@@ -5,6 +5,6 @@ sidebar_position: 1
 
 ## What is AdGuard Home?
 
-AdGuard Home is a network-wide software for blocking ads and tracking. Unlike AdGuard Public DNS and AdGuard Private DNS, AdGuard Home is designed to run on users’ own machines, which gives experienced users more control over their DNS traffic.
+AdGuard Home is a network-wide software for blocking ads and tracking. Unlike Public AdGuard DNS and Private AdGuard DNS, AdGuard Home is designed to run on users’ own machines, which gives experienced users more control over their DNS traffic.
 
 [This guide](getting-started.md) should help you get started.
diff --git a/docs/general/dns-providers.md b/docs/general/dns-providers.md
@@ -583,7 +583,7 @@ Recommended for most users, very flexible filtering with blocking most ads netwo
 
 #### Strict Filtering (RIC)
 
-More strictly filtering policies with blocking — ads, marketing, tracking, malware, clickbait, coinhive and phishing domains.
+More strictly filtering policies with blocking — ads, marketing, tracking, malware, clickbait, coinhive, malicious, and phishing domains.
 
 | Protocol       | Address                                            |                |
 |----------------|----------------------------------------------------|----------------|
@@ -1016,7 +1016,7 @@ Non-logging | Filters ads, trackers, phishing, etc. | DNSSEC | QNAME Minimizatio
 
 [Dandelion Sprout's Official DNS Server](https://github.com/DandelionSprout/adfilt/tree/master/Dandelion%20Sprout's%20Official%20DNS%20Server) is a personal DNS service hosted in Trondheim, Norway, using an AdGuard Home infrastructure.
 
-Blocks more ads and malware than AdGuard DNS thanks to more advanced syntax, but goes easier on trackers, and blocks alt-right tabloids and most imageboards. Logging is used to improve its used filterlists (e.g. by unblocking sites that shouldn't have been blocked), and to determine the least bad times for server system updates.
+Blocks more ads and malware than AdGuard DNS thanks to more advanced syntax, but goes easier on trackers, and blocks alt-right tabloids and most imageboards. Logging is used to improve its used filter lists (e.g. by unblocking sites that shouldn't have been blocked), and to determine the least bad times for server system updates.
 
 | Protocol       | Address                    |                                                        |
 |----------------|------------------------------------------------------------------|------------------|
diff --git a/docs/miscellaneous/create-dns-stamp.md b/docs/miscellaneous/create-dns-stamp.md
@@ -2,7 +2,7 @@
 
 This guide will show you how to create your own DNS stamp for Secure DNS. Secure DNS is a service that enhances your internet security and privacy by encrypting your DNS queries. This prevents your queries from being intercepted or manipulated by malicious actors.
 
-Secure DNS usually uses `tls://`, `https://` or `quic://` URLs. This is sufficient for most users and is the recommended way.
+Secure DNS usually uses `tls://`, `https://`, or `quic://` URLs. This is sufficient for most users and is the recommended way.
 
 However, if you need additional security, like pre-resolved server IPs and certificate pinning by hash, you may generate your own DNS stamp.
 
@@ -14,7 +14,7 @@ DNS stamps allow you to customize Secure DNS settings beyond the usual URLs. In
 
 ## Choosing the protocol
 
-Types of Secure DNS include `DNS-over-HTTPS (DoH)`, `DNS-over-QUIC (DoQ)`, and `DNS-over-TLS (DoT)` and some others. Choosing one of these protocols depends on the context in which you'll be using them.
+Types of Secure DNS include `DNS-over-HTTPS (DoH)`, `DNS-over-QUIC (DoQ)`, `DNS-over-TLS (DoT)`, and some others. Choosing one of these protocols depends on the context in which you'll be using them.
 
 ## Creating a DNS stamp
 
diff --git a/docs/private-dns/api/changelog.md b/docs/private-dns/api/changelog.md
@@ -12,7 +12,9 @@ toc_max_heading_level: 3
 
 This article contains the changelog for [AdGuard DNS API](private-dns/api/overview.md).
 
-## v1.9 (11 July 2024)
+## v1.9
+
+ *Released on July 11, 2024*
 
 - Added automatic device connection functionality:
     - New DNS server setting — `auto_connect_devices_enabled`, allowing approval for auto-connecting devices through a specific link type
@@ -26,7 +28,7 @@ This article contains the changelog for [AdGuard DNS API](private-dns/api/overvi
 - Added support for DNS-over-HTTPS with authentication:
     - New operation — reset DNS-over-HTTPS password for device
     - New device setting — `detect_doh_auth_only`. Disables all DNS connection methods except DNS-over-HTTPS with authentication
-    - New field in Device DNSAddresses — `dns_over_https_with_auth_url`. Indicates the URL to use when connecting using DNS-over-HTTPS with authentication
+    - New field in DeviceDNSAddresses — `dns_over_https_with_auth_url`. Indicates the URL to use when connecting using DNS-over-HTTPS with authentication
 
 ## v1.7
 
@@ -42,15 +44,15 @@ This article contains the changelog for [AdGuard DNS API](private-dns/api/overvi
     - Unlink an IPv4 address from a device
     - Request info on dedicated addresses associated with a device
 - Added new limits to Account limits:
-    - `dedicated_ipv4` — provides information about the amount of already allocated dedicated IPv4 addresses, as well as the limit on them
+    - `dedicated_ipv4` provides information about the amount of already allocated dedicated IPv4 addresses, as well as the limit on them
 - Removed deprecated field of DNSServerSettings:
     - `safebrowsing_enabled`
 
 ## v1.6
 
 *Released on January 22, 2024*
 
-- Added new section "Access settings" for DNS profiles (`access_settings`). By customizing these fields, you’ll be able to protect your AdGuard DNS server from unauthorized access:
+- Added new Access settings section for DNS profiles (`access_settings`). By customizing these fields, you’ll be able to protect your AdGuard DNS server from unauthorized access:
 
     - `allowed_clients` — here you can specify which clients can use your DNS server. This field will have priority over the `blocked_clients` field
     - `blocked_clients` — here you can specify which clients are not allowed to use your DNS server
@@ -61,7 +63,7 @@ This article contains the changelog for [AdGuard DNS API](private-dns/api/overvi
     - `access_rules` provides the sum of currently used `blocked_clients` and `blocked_domain_rules` values, as well as the limit on access rules
     - `user_rules` shows the amount of created user rules, as well as the limit on them
 
-- Added new setting: `ip_log_enabled` for the ability to log client IP addresses and domains.
+- Added a new `ip_log_enabled` setting to log client IP addresses and domains
 
 - Added new error code `FIELD_REACHED_LIMIT` to indicate when limits have been reached:
 
@@ -72,11 +74,11 @@ This article contains the changelog for [AdGuard DNS API](private-dns/api/overvi
 
 *Released on June 16, 2023*
 
-- Added new setting `block_nrd` and group all security-related settings to one place.
+- Added a new `block_nrd` setting and grouped all security-related settings in one place
 
 ### Model for safebrowsing settings changed
 
-From
+From:
 
 ``` json
 {
@@ -94,7 +96,7 @@ To:
 }
 ```
 
-where `enabled` is now control all settings in group, `block_dangerous_domains` is previous model field "enabled" and `block_nrd` is settings for filtering newly registered domains.
+where `enabled` now controls all settings in the group, `block_dangerous_domains` is the previous `enabled` model field, and `block_nrd` is a setting that blocks newly registered domains.
 
 ### Model for saving server settings changed
 
@@ -122,40 +124,40 @@ to:
 }
 ```
 
-here new field `safebrowsing_settings` is used instead of deprecated `safebrowsing_enabled`, whose value stored in `block_dangerous_domains`.
+here a new field `safebrowsing_settings` is used instead of the deprecated `safebrowsing_enabled`, whose value is stored in `block_dangerous_domains`.
 
 ## v1.4
 
 *Released on March 29, 2023*
 
-- Added configurable option for blocking response: default (0.0.0.0), REFUSED, NXDOMAIN or custom IP-address.
+- Added configurable option for blocking response: default (0.0.0.0), REFUSED, NXDOMAIN or custom IP address
 
 ## v1.3
 
 *Released on December 13, 2022*
 
-- Added method to get account limits.
+- Added method to get account limits
 
 ## v1.2
 
 *Released on October 14, 2022*
 
-- Added new protocol types DNS and DNSCRYPT. Deprecating the PLAIN_TCP, PLAIN_UDP, DNSCRYPT_TCP and DNSCRYPT_UDP that will be removed later.
+- Added new protocol types DNS and DNSCRYPT. Deprecating the PLAIN_TCP, PLAIN_UDP, DNSCRYPT_TCP and DNSCRYPT_UDP that will be removed later
 
 ## v1.1
 
 *Released on July 07, 2022*
 
-- Added methods to retrieve statistics by time, domains, companies and devices.
-- Added method for updating device settings.
-- Fixed required fields definition.
+- Added methods to retrieve statistics by time, domains, companies and devices
+- Added method for updating device settings
+- Fixed required fields definition
 
 ## v1.0
 
 *Released on February 22, 2022*
 
-- Added authentication.
-- CRUD operations with devices and DNS servers.
-- Query log.
-- Downloading DOT and DOT .mobileconfig.
-- Filter Lists and Web-Services.
+- Added authentication
+- CRUD operations with devices and DNS servers
+- Query log
+- Downloading DoH and DoT .mobileconfig
+- Filter lists and web services
diff --git a/docs/private-dns/api/reference.md b/docs/private-dns/api/reference.md
@@ -35,7 +35,7 @@ Gets account limits
 
 ##### Summary
 
-Lists allocated dedicated IPv4 addresses
+Lists dedicated IPv4 addresses
 
 ##### Responses
 
@@ -47,7 +47,7 @@ Lists allocated dedicated IPv4 addresses
 
 ##### Summary
 
-Allocates new dedicated IPv4
+Allocates new IPv4
 
 ##### Responses
 
diff --git a/docs/public-dns/solving-problems/how-to-flush-dns-cache.md b/docs/public-dns/solving-problems/how-to-flush-dns-cache.md
@@ -102,7 +102,7 @@ You will see the line *Successfully flushed the DNS Resolver Cache*. Done!
 
 ### Linux
 
-Linux does not have OS-level DNS caching unless a caching service such as systemd-resolved, DNSMasq, BIND or Nscd is installed and running. The process of clearing the DNS cache depends on the Linux distribution and the caching service used.
+Linux does not have OS-level DNS caching unless a caching service such as systemd-resolved, DNSMasq, BIND, or nscd is installed and running. The process of clearing the DNS cache depends on the Linux distribution and the caching service used.
 
 For each distribution you need to start a terminal window. Press Ctrl+Alt+T on your keyboard and use the corresponding command to clear the DNS cache for the service your Linux system is running.
 
