daxi20/AdGuardHome
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'master' into 4535-list-services

Browse Source
This commit is contained in:
Ainar Garipov
2022-08-25 18:24:07 +03:00
parent 56f78edb97 be1bc76cfa
commit 57c0b1203e
178 changed files with 5867 additions and 3011 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
openapi/openapi.yaml
View File

@@ -1409,7 +1409,6 @@
'required':
- 'enabled'
- 'id'
- 'last_updated'
- 'name'
- 'rules_count'
- 'url'
@@ -1447,6 +1446,10 @@
'type': 'array'
'items':
'$ref': '#/components/schemas/Filter'
'whitelist_filters':
'type': 'array'
'items':
'$ref': '#/components/schemas/Filter'
'user_rules':
'type': 'array'
'items':
@@ -1464,18 +1467,28 @@
'description': 'Filtering URL settings'
'properties':
'data':
'properties':
'enabled':
'type': 'boolean'
'name':
'type': 'string'
'url':
'type': 'string'
'type': 'object'
'$ref': '#/components/schemas/FilterSetUrlData'
'url':
'type': 'string'
'whitelist':
'type': 'boolean'
'FilterSetUrlData':
'type': 'object'
'description': 'Filter update data'
'required':
- 'enabled'
- 'name'
- 'url'
'properties':
'enabled':
'type': 'boolean'
'name':
'example': 'AdGuard Simplified Domain Names filter'
'type': 'string'
'url':
'type': 'string'
'example': >
https://adguardteam.github.io/AdGuardSDNSFilter/Filters/filter.txt
'FilterRefreshRequest':
'type': 'object'
'description': 'Refresh Filters request data'
@@ -1873,6 +1886,8 @@
'description': 'Previously added URL containing filtering rules'
'type': 'string'
'example': 'https://filters.adtidy.org/windows/filters/15.txt'
'whitelist':
'type': 'boolean'
'QueryLogItem':
'type': 'object'
'description': 'Query log item'

152
openapi/v1.yaml
View File

@@ -144,6 +144,13 @@
'/health-check':
'get':
'operationId': 'HealthCheck'
'responses':
'200':
'description': >
An OK response.
'content':
'text/plain':
'example': 'OK'
'servers':
- 'url': '/'
'summary': 'Check if the server is up.'
@@ -874,6 +881,26 @@
'tags':
- 'settings'
'/settings/http':
'patch':
'operationId': 'PatchV1SettingsHttp'
'requestBody':
'$ref': '#/components/requestBodies/PatchV1SettingsHttpReq'
'responses':
'200':
'$ref': '#/components/responses/PatchV1SettingsHttpResp'
'400':
'$ref': '#/components/responses/BadRequestResp'
'401':
'$ref': '#/components/responses/UnauthorizedResp'
'422':
'$ref': '#/components/responses/UnprocessableEntityResp'
'500':
'$ref': '#/components/responses/InternalServerErrorResp'
'summary': 'Update web interface settings.'
'tags':
- 'settings'
'/settings/log':
'patch':
'operationId': 'PatchV1SettingsLog'
@@ -1209,6 +1236,13 @@
'$ref': '#/components/schemas/PatchV1SettingsDnsReq'
'required': true
'PatchV1SettingsHttpReq':
'content':
'application/json':
'schema':
'$ref': '#/components/schemas/PatchV1SettingsHttpReq'
'required': true
'PatchV1SettingsLogReq':
'content':
'application/json':
@@ -1604,6 +1638,14 @@
'description': >
A successful response to a `PATCH /api/v1/settings/dns` request.
'PatchV1SettingsHttpResp':
'content':
'application/json':
'schema':
'$ref': '#/components/schemas/PatchV1SettingsHttpResp'
'description': >
A successful response to a `PATCH /api/v1/settings/http` request.
'PatchV1SettingsLogResp':
'content':
'application/json':
@@ -2229,6 +2271,9 @@
- 'description': >
DNS server settings.
'example':
'addresses':
- '127.0.0.1:53'
- '192.168.1.1:53'
'blocking_mode': 'default'
'bootstrap_servers':
- '9.9.9.10'
@@ -2244,7 +2289,9 @@
'upstream_servers':
- '1.1.1.1'
- '8.8.8.8'
'upstream_timeout': '1s'
'required':
- 'addresses'
- 'blocking_mode'
- 'bootstrap_servers'
- 'cache_size'
@@ -2256,6 +2303,7 @@
- 'rate_limit'
- 'upstream_mode'
- 'upstream_servers'
- 'upstream_timeout'
'DnsSettingsPatch':
'description': >
@@ -2265,6 +2313,13 @@
'upstream_servers':
- '1.1.1.1'
'properties':
'addresses':
'description': >
Addresses on which to serve plain DNS, in ip:port format. Empty
array disables plain DNS.
'items':
'type': 'string'
'type': 'array'
'blocking_ipv4':
'description': >
IPv4 address to respond with when `blocking_mode` is `custom_ip`.
@@ -2340,6 +2395,10 @@
'items':
'$ref': '#/components/schemas/UpstreamServerAddr'
'type': 'array'
'upstream_timeout':
'description': >
Upstream request timeout, as a human readable duration.
'type': 'string'
'type': 'object'
'DnsType':
@@ -3038,6 +3097,8 @@
'$ref': '#/components/schemas/DhcpSettings'
'dns':
'$ref': '#/components/schemas/DnsSettings'
'http':
'$ref': '#/components/schemas/HttpSettings'
'log':
'$ref': '#/components/schemas/LogSettings'
'protection':
@@ -3049,6 +3110,7 @@
'required':
- 'dhcp'
- 'dns'
- 'http'
- 'log'
- 'protection'
- 'stats'
@@ -3393,11 +3455,17 @@
'description': >
Information about the AdGuard Home server.
'example':
'arch': 'amd64'
'channel': 'release'
'new_version': 'v0.106.1'
'new_version': 'v0.108.1'
'os': 'linux'
'start': 1614345496000
'version': 'v0.106.0'
'version': 'v0.108.0'
'properties':
'arch':
'description': >
CPU architecture.
'type': 'string'
'channel':
'$ref': '#/components/schemas/Channel'
'new_version':
@@ -3405,6 +3473,10 @@
New available version of AdGuard Home to which the server can be
updated, if any. If there are none, this field is absent.
'type': 'string'
'os':
'description': >
Operating system type.
'type': 'string'
'start':
'description': >
Unix time at which AdGuard Home started working, in milliseconds.
@@ -3415,11 +3487,60 @@
Current AdGuard Home version.
'type': 'string'
'required':
- 'arch'
- 'channel'
- 'os'
- 'start'
- 'version'
'type': 'object'
'HttpSettings':
'allOf':
- '$ref': '#/components/schemas/HttpSettingsPatch'
- 'description': >
HTTP interface server settings.
**TODO(a.garipov): Finish, split from TLS settings.**
'example':
'addresses':
- '127.0.0.1:80'
- '192.168.1.1:80'
'secure_addresses':
- '127.0.0.1:443'
- '192.168.1.1:443'
'force_https': true
'required':
- 'addresses'
- 'secure_addresses'
- 'force_https'
'HttpSettingsPatch':
'description': >
HTTP server settings update object.
'example':
'force_https': false
'properties':
'addresses':
'description': >
Addresses on which to serve the plain-HTTP web interface and API, in
ip:port format. Empty array disables the web interface over plain
HTTP.
'items':
'type': 'string'
'type': 'array'
'force_https':
'description': >
If `true`, enabled the HTTP-to-HTTPS redirect.
'type': 'boolean'
'secure_addresses':
'description': >
Addresses on which to serve the HTTPS web interface and API, in
ip:port format. Empty array disables the web interface over HTTPS.
'items':
'type': 'string'
'type': 'array'
'type': 'object'
'InternalServerErrorResp':
'example':
'code': 'RNT000'
@@ -3713,6 +3834,12 @@
'PatchV1SettingsDnsResp':
'$ref': '#/components/schemas/DnsSettings'
'PatchV1SettingsHttpReq':
'$ref': '#/components/schemas/HttpSettingsPatch'
'PatchV1SettingsHttpResp':
'$ref': '#/components/schemas/HttpSettings'
'PatchV1SettingsLogReq':
'$ref': '#/components/schemas/LogSettingsPatch'
@@ -4278,7 +4405,7 @@
Validatable TLS settings.
'example':
'certificate_path': '/etc/ssl/example.com.cert'
'port_dns_over_quic': 784
'port_dns_over_quic': 853
'port_dns_over_tls': 853
'port_https': 443
'private_key_path': '/etc/ssl/example.com.key'
@@ -4300,7 +4427,7 @@
sent.
'type': 'string'
'port_dns_over_quic':
'default': 784
'default': 853
'description': >
The DNS-over-QUIC port. If `0`, DNS-over-QUIC is disabled.
'format': 'int64'
@@ -4738,15 +4865,13 @@
'example':
'certificate_path': '/etc/ssl/example.com.cert'
'enabled': true
'force_https': true
'port_dns_over_quic': 784
'port_dns_over_quic': 853
'port_dns_over_tls': 853
'port_https': 443
'private_key_path': '/etc/ssl/example.com.key'
'server_name': 'dns.example.com'
'required':
- 'enabled'
- 'force_https'
- 'port_dns_over_quic'
- 'port_dns_over_tls'
- 'port_https'
@@ -4781,12 +4906,8 @@
over HTTPS, and the DNS server will listen requests over
DNS-over-TLS and other protocols.
'type': 'boolean'
'force_https':
'description': >
If `true`, enabled the HTTP-to-HTTPS redirect.
'type': 'boolean'
'port_dns_over_quic':
'default': 784
'default': 853
'description': >
The DNS-over-QUIC port. If `0`, DNS-over-QUIC is disabled.
'format': 'int64'
@@ -4876,13 +4997,12 @@
* `94.140.14.140`: plain DNS-over-UDP.
* `tls://dns-unfiltered.adguard.com`: encrypted DNS-over-TLS.
* `tls://unfiltered.adguard-dns.com`: encrypted DNS-over-TLS.
* `https://dns-unfiltered.adguard.com/dns-query`: encrypted
* `https://unfiltered.adguard-dns.com/dns-query`: encrypted
DNS-over-HTTPS.
* `quic://dns-unfiltered.adguard.com:784`: encrypted DNS-over-QUIC
(experimental).
* `quic://unfiltered.adguard-dns.com`: encrypted DNS-over-QUIC.
* `tcp://94.140.14.140`: plain DNS-over-TCP.