all: imp docs

AdguardTeam · Jul 13, 2023 · 2279b03 · 2279b03
1 parent 6af8019
commit 2279b03
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 9 deletions.
diff --git a/internal/home/clientshttp.go b/internal/home/clientshttp.go
@@ -34,10 +34,12 @@ type clientJSON struct {
 	WHOIS          *whois.Info                 `json:"whois_info,omitempty"`
 	SafeSearchConf *filtering.SafeSearchConfig `json:"safe_search"`
 
-	Schedule *schedule.Weekly `json:"schedule"`
+	// Schedule is blocked services schedule for every day of the week.
+	Schedule *schedule.Weekly `json:"blocked_services_schedule"`
 
 	Name string `json:"name"`
 
+	// BlockedServices is the names of blocked services.
 	BlockedServices []string `json:"blocked_services"`
 	IDs             []string `json:"ids"`
 	Tags            []string `json:"tags"`

diff --git a/openapi/CHANGELOG.md b/openapi/CHANGELOG.md
@@ -4,7 +4,7 @@
 
 ## v0.108.0: API changes
 
-## v0.107.34: API changes
+## v0.107.35: API changes
 
 ### `/control/clients` HTTP APIs
 

diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml
@@ -2480,7 +2480,7 @@
         'time_zone':
           'description': >
             Time zone name according to IANA time zone database.  For example
-            "Europe/Brussels".  "Local" represents the system's local time
+            `Europe/Brussels`.  `Local` represents the system's local time
             zone.
           'type': 'string'
         'sun':
@@ -2500,17 +2500,25 @@
     'DayRange':
       'type': 'object'
       'description': >
-        DayRange consists of "start" and "end", which are the number of
-        milliseconds elapsed from the start of the day.  If "start" and "end"
-        are equal to "0" day range is empty.  Otherwise "start" must be greater
-        or equal to "0" and less than "86400000" (24 hours),  "end" must be
-        greater than "start" and less or equal to "86400000".  "start" and
-        "end" are expected to be rounded to minutes.
+        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.'