Skip to content

Commit 5b64326

Browse files
Clarified effective validity period filter usage
Signed-off-by: tomni <thomas.nicolai@frequenz.com>
1 parent 5aec0b3 commit 5b64326

1 file changed

Lines changed: 15 additions & 4 deletions

File tree

proto/frequenz/api/platformassets/v1alpha1/platformassets.proto

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -437,7 +437,7 @@ message ListGridpoolEnergySchedulesRequest {
437437
// entry.start_time < time_series_interval.end_time
438438
// AND
439439
// entry.start_time + schedule.delivery_duration >
440-
// time_series_interval.start_time
440+
// time_series_interval.start_time
441441
// ```
442442
//
443443
// The returned schedules contain only matching `time_series` entries. If
@@ -447,14 +447,25 @@ message ListGridpoolEnergySchedulesRequest {
447447
// Optional. Return only schedules whose effective validity period overlaps
448448
// this interval.
449449
//
450-
// The effective validity period starts at
451-
// `validity_period.start_time`.
450+
// Use this filter to retrieve all schedules that are applicable at any
451+
// point during the requested time window.
452+
//
453+
// A schedule matches if its effective validity period intersects the
454+
// requested interval:
455+
//
456+
// ```text
457+
// effective_start_time < effective_validity_period.end_time
458+
// AND
459+
// effective_end_time > effective_validity_period.start_time
460+
// ```
461+
//
462+
// The effective validity period starts at `validity_period.start_time`.
452463
//
453464
// If `cancel_time` is set before `validity_period.end_time`, the effective
454465
// validity period ends at `cancel_time`. Otherwise, it ends at
455466
// `validity_period.end_time`.
456467
//
457-
// If omitted, no validity-period filtering is applied.
468+
// If omitted, no effective-validity-period filtering is applied.
458469
frequenz.api.common.v1alpha8.types.Interval effective_validity_period = 4;
459470
}
460471

0 commit comments

Comments
 (0)