Skip to content

Commit 30fa97b

Browse files
* Added two clarifications to FilterOption and ResamplingOptions
Signed-off-by: tomni <thomas.nicolai@frequenz.com>
1 parent 3c6f1e5 commit 30fa97b

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

proto/frequenz/api/reporting/v1alpha10/reporting.proto

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,9 @@ service ReportingService {
186186
// whether optional data blocks (e.g. bounds, operational states) are emitted
187187
// in stream responses.
188188
//
189+
// If a FilterOption is omitted, the default behavior is equivalent to
190+
// FILTER_OPTION_EXCLUDE.
191+
//
189192
enum FilterOption {
190193
// UNSPECIFIED: Default unspecified value — must not be used.
191194
FILTER_OPTION_UNSPECIFIED = 0;
@@ -269,8 +272,8 @@ message TimeFilter {
269272
// analysis and backtesting.
270273
//
271274
// !!! example "Example: Downsampling from 1-second to 15-minute intervals"
272-
// The stored time series has a native resolution of Δt = 1 second.
273-
// Resampling is requested with a resolution of ΔT = 15 minutes. In
275+
// The stored time series has a effective sampling resolution of Δt = 1
276+
// second. Resampling is requested with a resolution of ΔT = 15 minutes. In
274277
// this case all native samples whose timestamps fall within an interval
275278
// [t, t + Δt) contribute to the aggregated value for that interval. The
276279
// timestamp of the aggregated sample is exactly t, the start of the
@@ -318,6 +321,9 @@ message ResamplingOptions {
318321
// aggregated across microgrid electrical components. It serves as the
319322
// configuration guideline for any aggregation operation.
320323
//
324+
// Aggregation formulas operate on exactly one metric per configuration.
325+
// Cross-metric aggregation is not supported.
326+
//
321327
// !!! example
322328
// To calculate the total voltage across three electrical components in
323329
// series with IDs 1, 2, and 3, the configuration could look like:

0 commit comments

Comments
 (0)