public-transport/friendly-public-transport-format

add vehicle type

Open

#46 opened on Aug 11, 2018

View on GitHub
 (2 comments) (1 reaction) (0 assignees) (3 forks)github user discovery
designenhancementhelp wantedmajor

Repository metrics

Stars
 (139 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

As far as I can tell, the only major type of public transformation information we are currently completely unable to express in FPTF is vehicles and their location. I therefore propose adding a vehicle type to FPTF@2 which could look as follows:

{
    type: 'vehicle', // required
    id: '123456', // required
    location: { // optional
        type: 'location',
        longitude: 52.5,
        latitude: 13.2
    },
    accessible: true, // barrier-free (e.g. for wheelchair users), optional
    model: '485' // model information, e.g. "Deutsche Bahn, Baureihe 485", optional
}

Note that this makes much more sense if we actually implement #43 in FPTF@2 because updating vehicle location could then be done by simply publishing more recent vehicle objects sharing the same id, indicating changed position information.

Opinions? 😄

Contributor guide

Research direction
Examine the current FPTF specification to understand how existing types are structured, then propose a vehicle type following the same pattern.
Tech stack
None
Domain
dataapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJSON
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70