Skip to content

Commit fb4f172

Browse files
author
cibot
committed
Definitions Update scan_scheduler
1 parent 41f5d92 commit fb4f172

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

alsdkdefs/apis/scan_scheduler/scan_scheduler.v2.yaml

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1532,12 +1532,31 @@ components:
15321532
type: string
15331533
example:
15341534
"2024-01-22 08:00"
1535-
1535+
current:
1536+
description: |-
1537+
Allows to determine whether the scan interval is currently active or not.
1538+
When `current` is `true` it means the interval is still active.
1539+
When `current` is `false` it means it is a previous interval.
1540+
Let's consider the following examples
1541+
- For daily schedules `current` will be `true` until 23:59:59 on that day.
1542+
All previous intervals will have `current` property set to `false`.
1543+
- For weekly schedules `current` will be `true` from Monday 00:00:00
1544+
until Sunday 23:59:59 on that week.
1545+
- For monthly schedules `current` will be `true` from 1st of the month 00:00:00
1546+
until last day of the month (e.g. 30th of April) until 23:59:59
1547+
type: boolean
15361548
open:
15371549
description: |-
1538-
Allows to determine whether the scan interval is active or not.
1539-
When open is `false` it means there should be no more scans during this
1540-
scanning window.
1550+
Allows to determine whether scans are still allowed to run
1551+
within the scan interval.
1552+
When open is `true` it means there are still active scanning windows
1553+
in the current interval. When it's `false` it means there are no more
1554+
scan windows in the interval for the schedule.
1555+
Note it is NOT guaranteed the flag will remain `false` until the end
1556+
of the interval. It may flip back to `true` after user has added
1557+
new scan windows to the schedule which permit scanning within the interval.
1558+
The `open` property will always be `false` for previous scan intervals
1559+
(i.e. where `current` is `false`)
15411560
type: boolean
15421561
timezone:
15431562
description: |-

0 commit comments

Comments
 (0)