Skip to content

Commit 741c63e

Browse files
committed
docs: add schedule window fields to management API spec
1 parent 29e705c commit 741c63e

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

docs/v3-openapi.yaml

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5744,6 +5744,10 @@ components:
57445744
type: string
57455745
example: "America/New_York"
57465746
description: Defaults to "UTC". In IANA format ("America/New_York"). If set then it will trigger at the CRON frequency in that timezone and respect daylight savings time.
5747+
window:
5748+
type: string
5749+
example: "30m"
5750+
description: Optionally spread runs by assigning each schedule a stable time within this window after its cron time. Use a whole duration in minutes or hours up to 24 hours ("30m", "2h", "24h"), or a percentage of the interval between runs ("30%", "100%"). Use "0m" for no spreading.
57475751
required:
57485752
- task
57495753
- cron
@@ -5761,6 +5765,10 @@ components:
57615765
type: string
57625766
example: "America/New_York"
57635767
description: Defaults to "UTC". In IANA format ("America/New_York"). If set then it will trigger at the CRON frequency in that timezone and respect daylight savings time.
5768+
window:
5769+
type: string
5770+
example: "30m"
5771+
description: Optionally spread runs by assigning each schedule a stable time within this window after its cron time. Use a whole duration in minutes or hours up to 24 hours ("30m", "2h", "24h"), or a percentage of the interval between runs ("30%", "100%"). Use "0m" for no spreading.
57645772
required:
57655773
- task
57665774
- cron
@@ -5812,11 +5820,20 @@ components:
58125820
type: string
58135821
example: "America/New_York"
58145822
description: Defaults to UTC. In IANA format, if set then it will trigger at the CRON frequency in that timezone and respect daylight savings time.
5823+
window:
5824+
type: string
5825+
example: "30m"
5826+
description: The configured window used to spread runs after their cron time, if set. A whole duration such as "30m" or "2h", or a percentage such as "30%".
58155827
nextRun:
58165828
type: string
58175829
format: date-time
5818-
description: The next time the schedule will run
5830+
description: The next nominal cron time the schedule will run
58195831
example: "2024-04-01T00:00:00Z"
5832+
nextRunEffectiveAt:
5833+
type: string
5834+
format: date-time
5835+
description: The stable assigned time the next run will actually start. Equals `nextRun` when no window is set.
5836+
example: "2024-04-01T00:12:00Z"
58205837
environments:
58215838
type: array
58225839
items:

0 commit comments

Comments
 (0)