Skip to content

Commit

Permalink
spec: update the description of the FlowSegment.timerange
Browse files Browse the repository at this point in the history
Be specific about when the timerange uses an exclusive (samples have
duration) or inclusive end (samples don't have a duration).
  • Loading branch information
philipnbbc committed Nov 28, 2024
1 parent c6afd19 commit d8eaf72
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion api/schemas/flow-segment.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"$ref": "timestamp.json"
},
"timerange": {
"description": "The timerange from the first sample in the segment to the last, with an inclusive start and inclusive or exclusive end, as described by the [TimeRange](../schemas/timerange#top) type. Note that where temporal re-ordering is used, this refers to the presentation timeline.",
"description": "The timerange for the samples contained in the segment. If samples have a duration then the timerange end is exclusive and covers at least the duration of the last sample. The exclusive timerange end will typically be set to the timestamp of the next sample. If the samples don't have a duration then the timerange end is inclusive. Format is described by the [TimeRange](../schemas/timerange#top) type. Note that where temporal re-ordering is used, the timerange and samples refers to the presentation timeline.",
"$ref": "timerange.json"
},
"last_duration": {
Expand Down

0 comments on commit d8eaf72

Please sign in to comment.