Skip to content

RFC: track API #2504

Description

@tkurki

There have been sporadic, uncoordinated efforts towards having a common API for accessing track related data. With the advent of History API it is high time to formalise an API and align the implementations.

Use cases

  • display all self/all/some collection of vessels' tracks on a map or in a list, based on map bounding box (bbox) and/or timespan
    • note that bbox can be tiny or span the globe, affecting resolution
  • select a track and display metadata about it
  • track metadata:
    • timespan
    • length
    • bounding box
    • name
    • number of points?
    • SK context
    • vessel name
    • is self
  • select a track on the map and zoom to it
  • download a track's data (GPX, GeoJSON, PMTiles)

The following highlighted items are frequent Freeboard-SK actions.

  • Upload one or more tracks and associated metadata
  • View a list of the uploaded tracks by name / id
  • Select tracks to view on map.
  • Select a track and download it with metadata in GPX
  • List tracks' metadata for a given timespan for self/all/some collection of vessels with geobounds

This relates to both History API, that allows querying navigation.position over time resembling a track API, as well as Resources API, that has similar constructs, namely routes, as first class citizens.

More related work

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions