Skip to content

Commit 92a911e

Browse files
authored
Document valid values for count and interval (#179)
The values are chosen based on the limits set by the rrule library used in the service, see: https://github.com/fmeringdal/rust-rrule?tab=readme-ov-file#limitation-and-limits `4096` was chosen as it seemed large enough for any sane usecase but not large enough to cause DoS for the service. refs frequenz-io/frequenz-service-dispatch#122 refs frequenz-io/frequenz-service-dispatch#78
2 parents 640bcc4 + e8a7eb8 commit 92a911e

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

RELEASE_NOTES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ In this release, we have made some changes to the API to improve the user experi
1919
* Enhanced `payload` documentation.
2020
* Add YEARLY frequency to the recurrence definition.
2121
* Add parameters for pagination and sorting.
22+
* Documentation of valid values for `count` and `interval` fields was added.
2223

2324
## Bug Fixes
2425

proto/frequenz/api/dispatch/v1/dispatch.proto

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,7 @@ message RecurrenceRule {
267267
oneof count_or_until {
268268
// The number of times this dispatch should recur.
269269
// If this field is set, the dispatch will recur the given number of times.
270+
// Valid values are 1 to 4096.
270271
uint32 count = 1;
271272

272273
// The end time of this dispatch in UTC.
@@ -283,6 +284,7 @@ message RecurrenceRule {
283284
// - Every 2 hours:
284285
// freq = FREQUENCY_HOURLY
285286
// interval = 2
287+
// Valid values typically range between 1 and 10_000, depending on the implementation.
286288
uint32 interval = 2;
287289

288290
// When this dispatch should end.

0 commit comments

Comments
 (0)