Pull request 1907: 951-blocked-services-schedule-api
Updates #951. Squashed commit of the following: commit 6b840fd516f5a87fde0420e3aceb9c239b22c974 Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Tue Aug 29 19:53:03 2023 +0300 client: imp docs more commit 7fc8f0363fbe4c4266cb0f67428fe4d18c351d2d Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Tue Aug 29 19:40:00 2023 +0300 client: imp docs commit 00bc14d5760614f2797714cdc2c4c19b1a94b86e Author: Ildar Kamalov <ik@adguard.com> Date: Mon Aug 28 18:43:49 2023 +0300 try to fix lock file commit d749df74b576091e0b58928d86ea8b3b49f919da Merge: c69f9230be1f6229e5Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Mon Aug 28 18:14:02 2023 +0300 Merge branch 'master' into 951-blocked-services-schedule-api commit c69f9230b12f7c983db06b74324b3df77d74b32b Author: Ildar Kamalov <ik@adguard.com> Date: Mon Aug 28 17:16:20 2023 +0300 revert eslintrc commit b37916c2dff0ddea5293d87570bb58e3443d2d21 Author: Ildar Kamalov <ik@adguard.com> Date: Mon Aug 28 12:02:39 2023 +0300 fix translations commit f5bb67d81506c687d0abd580049a3eee0af808e0 Author: Ildar Kamalov <ik@adguard.com> Date: Mon Aug 28 11:43:57 2023 +0300 fix helpers commit 13ec6a8b3a0acfb62762ae7e46c6e98eb7c82212 Author: Ildar Kamalov <ik@adguard.com> Date: Mon Aug 28 11:24:57 2023 +0300 remove todo commit 23724ec2fd683ed17b9f1cee841ad9aaf4c9d04f Author: Ildar Kamalov <ik@adguard.com> Date: Mon Aug 28 09:56:56 2023 +0300 add clients schedule form commit 84d29e558a329068e64e7a95ee183946aa4515b5 Author: Ildar Kamalov <ik@adguard.com> Date: Fri Aug 25 17:44:40 2023 +0300 fix schedule form commit 83e4017688082e9eb670091d5a24d98157050502 Author: Ildar Kamalov <ik@adguard.com> Date: Fri Aug 18 12:58:16 2023 +0300 remove unused commit ef2b68e138da382e3cf42586ae604e12d9493504 Author: Ildar Kamalov <ik@adguard.com> Date: Fri Aug 18 12:57:37 2023 +0300 client: fix translation string commit 32ea80c968f52f18adbc811b2f06874644cdfe20 Author: Ildar Kamalov <ik@adguard.com> Date: Fri Aug 18 12:26:26 2023 +0300 wip schedule commit 9b770873859186c9424c8d108812e32ddff33bad Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Fri Jul 21 14:29:50 2023 +0300 all: imp naming commit ea4e9514ea3b264bcce7f2a301db817de4e87059 Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Wed Jul 19 18:09:27 2023 +0300 all: imp code commit 98a705bdaa5c1e79394c73e5d75af2416fe9f297 Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Tue Jul 18 18:23:26 2023 +0300 all: imp naming commit 4f84b55c7bfc9f7b680feac0ec45f5ea9189299a Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Fri Jul 14 15:01:17 2023 +0300 all: add global schedule api commit 87cf1646869ee9138964b47a27b7493674c8854a Merge: cabb80ac12adc8624cAuthor: Stanislav Chzhen <s.chzhen@adguard.com> Date: Fri Jul 14 12:09:29 2023 +0300 Merge branch 'master' into 951-blocked-services-schedule-api commit cabb80ac16de437a8118bb0166479574379c97a3 Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Thu Jul 13 13:37:23 2023 +0300 openapi: fix typo commit 2279b03acbcfc3d76216f8aaf30ae1c7894127bc Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Thu Jul 13 12:26:19 2023 +0300 all: imp docs ... and 3 more commits
This commit is contained in:
Stanislav Chzhen
@@ -4,6 +4,86 @@
|
||||
|
||||
## v0.108.0: API changes
|
||||
|
||||
## v0.107.37: API changes
|
||||
|
||||
### Deprecated blocked services APIs
|
||||
|
||||
* The `GET /control/blocked_services/list` HTTP API; use the new `GET
|
||||
/control/blocked_services/get` API instead.
|
||||
|
||||
* The `POST /control/blocked_services/set` HTTP API; use the new `PUT
|
||||
/control/blocked_services/update` API instead.
|
||||
|
||||
### New blocked services APIs
|
||||
|
||||
* The new `GET /control/blocked_services/get` HTTP API.
|
||||
|
||||
* The new `PUT /control/blocked_services/update` HTTP API allows config
|
||||
updates.
|
||||
|
||||
These APIs accept and return a JSON object with the following format:
|
||||
|
||||
```json
|
||||
{
|
||||
"schedule": {
|
||||
"time_zone": "Local",
|
||||
"sun": {
|
||||
"start": 46800000,
|
||||
"end": 82800000
|
||||
}
|
||||
},
|
||||
"ids": [
|
||||
"vk"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### `/control/clients` HTTP APIs
|
||||
|
||||
The following HTTP APIs have been changed:
|
||||
|
||||
* `GET /control/clients`;
|
||||
* `GET /control/clients/find?ip0=...&ip1=...&ip2=...`;
|
||||
* `POST /control/clients/add`;
|
||||
* `POST /control/clients/update`;
|
||||
|
||||
The new field `blocked_services_schedule` has been added to JSON objects. It
|
||||
has the following format:
|
||||
|
||||
```json
|
||||
{
|
||||
"time_zone": "Local",
|
||||
"sun": {
|
||||
"start": 0,
|
||||
"end": 86400000
|
||||
},
|
||||
"mon": {
|
||||
"start": 60000,
|
||||
"end": 82800000
|
||||
},
|
||||
"thu": {
|
||||
"start": 120000,
|
||||
"end": 79200000
|
||||
},
|
||||
"tue": {
|
||||
"start": 180000,
|
||||
"end": 75600000
|
||||
},
|
||||
"wed": {
|
||||
"start": 240000,
|
||||
"end": 72000000
|
||||
},
|
||||
"fri": {
|
||||
"start": 300000,
|
||||
"end": 68400000
|
||||
},
|
||||
"sat": {
|
||||
"start": 360000,
|
||||
"end": 64800000
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## v0.107.36: API changes
|
||||
|
||||
### The new fields `"top_upstreams_responses"` and `"top_upstreams_avg_time"` in `Stats` object
|
||||
|
||||
@@ -1001,6 +1001,9 @@
|
||||
'$ref': '#/components/schemas/BlockedServicesAll'
|
||||
'/blocked_services/list':
|
||||
'get':
|
||||
'deprecated': true
|
||||
'description': >
|
||||
Deprecated: Use `GET /blocked_services/get` instead.
|
||||
'tags':
|
||||
- 'blocked_services'
|
||||
'operationId': 'blockedServicesList'
|
||||
@@ -1014,6 +1017,9 @@
|
||||
'$ref': '#/components/schemas/BlockedServicesArray'
|
||||
'/blocked_services/set':
|
||||
'post':
|
||||
'deprecated': true
|
||||
'description': >
|
||||
Deprecated: Use `PUT /blocked_services/update` instead.
|
||||
'tags':
|
||||
- 'blocked_services'
|
||||
'operationId': 'blockedServicesSet'
|
||||
@@ -1026,6 +1032,34 @@
|
||||
'responses':
|
||||
'200':
|
||||
'description': 'OK.'
|
||||
'/blocked_services/get':
|
||||
'get':
|
||||
'tags':
|
||||
- 'blocked_services'
|
||||
'operationId': 'blockedServicesSchedule'
|
||||
'summary': 'Get blocked services'
|
||||
'responses':
|
||||
'200':
|
||||
'description': 'OK.'
|
||||
'content':
|
||||
'application/json':
|
||||
'schema':
|
||||
'$ref': '#/components/schemas/BlockedServicesSchedule'
|
||||
'/blocked_services/update':
|
||||
'put':
|
||||
'tags':
|
||||
- 'blocked_services'
|
||||
'operationId': 'blockedServicesScheduleUpdate'
|
||||
'summary': 'Update blocked services'
|
||||
'requestBody':
|
||||
'content':
|
||||
'application/json':
|
||||
'schema':
|
||||
'$ref': '#/components/schemas/BlockedServicesSchedule'
|
||||
'required': true
|
||||
'responses':
|
||||
'200':
|
||||
'description': 'OK.'
|
||||
'/rewrite/list':
|
||||
'get':
|
||||
'tags':
|
||||
@@ -2485,6 +2519,54 @@
|
||||
'type': 'boolean'
|
||||
'youtube':
|
||||
'type': 'boolean'
|
||||
'Schedule':
|
||||
'type': 'object'
|
||||
'description': >
|
||||
Sets periods of inactivity for filtering blocked services. The
|
||||
schedule contains 7 days (Sunday to Saturday) and a time zone.
|
||||
'properties':
|
||||
'time_zone':
|
||||
'description': >
|
||||
Time zone name according to IANA time zone database. For example
|
||||
`Europe/Brussels`. `Local` represents the system's local time
|
||||
zone.
|
||||
'type': 'string'
|
||||
'sun':
|
||||
'$ref': '#/components/schemas/DayRange'
|
||||
'mon':
|
||||
'$ref': '#/components/schemas/DayRange'
|
||||
'tue':
|
||||
'$ref': '#/components/schemas/DayRange'
|
||||
'wed':
|
||||
'$ref': '#/components/schemas/DayRange'
|
||||
'thu':
|
||||
'$ref': '#/components/schemas/DayRange'
|
||||
'fri':
|
||||
'$ref': '#/components/schemas/DayRange'
|
||||
'sat':
|
||||
'$ref': '#/components/schemas/DayRange'
|
||||
'DayRange':
|
||||
'type': 'object'
|
||||
'description': >
|
||||
The single interval within a day. It begins at the `start` and ends
|
||||
before the `end`.
|
||||
'properties':
|
||||
'start':
|
||||
'type': 'number'
|
||||
'description': >
|
||||
The number of milliseconds elapsed from the start of a day. It
|
||||
must be less than `end` and is expected to be rounded to minutes.
|
||||
So the maximum value is `86340000` (23 hours and 59 minutes).
|
||||
'minimum': 0
|
||||
'maximum': 86340000
|
||||
'end':
|
||||
'type': 'number'
|
||||
'description': >
|
||||
The number of milliseconds elapsed from the start of a day. It is
|
||||
expected to be rounded to minutes. The maximum value is `86400000`
|
||||
(24 hours).
|
||||
'minimum': 0
|
||||
'maximum': 86400000
|
||||
'Client':
|
||||
'type': 'object'
|
||||
'description': 'Client information.'
|
||||
@@ -2513,6 +2595,8 @@
|
||||
'$ref': '#/components/schemas/SafeSearchConfig'
|
||||
'use_global_blocked_services':
|
||||
'type': 'boolean'
|
||||
'blocked_services_schedule':
|
||||
'$ref': '#/components/schemas/Schedule'
|
||||
'blocked_services':
|
||||
'type': 'array'
|
||||
'items':
|
||||
@@ -2793,6 +2877,17 @@
|
||||
- 'name'
|
||||
- 'rules'
|
||||
'type': 'object'
|
||||
'BlockedServicesSchedule':
|
||||
'type': 'object'
|
||||
'properties':
|
||||
'schedule':
|
||||
'$ref': '#/components/schemas/Schedule'
|
||||
'ids':
|
||||
'description': >
|
||||
The names of the blocked services.
|
||||
'type': 'array'
|
||||
'items':
|
||||
'type': 'string'
|
||||
'CheckConfigRequest':
|
||||
'type': 'object'
|
||||
'description': 'Configuration to be checked'
|
||||
|
||||
Reference in New Issue
Block a user