Skip to content

[BUG] Segments are not explicitly described as returned in time order #219

Description

@samdbmg

Describe the bug
The documentation for GET /flows/<flowid>/segments doesn't explicitly say that segments should be returned in time order, but implies it by the existence of ?reverse_order

Expected behavior
While most practical implementations return the segments in time order, many players/readers rely on being able to assume the list is sorted, so it should be called out explicitly.

Suggested fix
Call out explicitly that the results should be sorted in order

Additional context
Found as part of google/virtual-broadcast-production-assistant#314

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationThis issue relates to an improvement to the documentation or examplesspecThis issue will generate a specification change

    Type

    No fields configured for Bug.

    Projects

    Status
    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions