openmobilityfoundation / openmobilityfoundation/mobility-data-specification

Adding a field in trip objects to cover cancelled trips easier

Open
#889 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Passenger Schema
Dominant language
No language data
Stars
746
Forks
252
Avg merge
3d 16h
Merged PRs (30d)
2

Description

When integrating the taxi and passenger services data, we realized it was complex today to send a trip object in cases where the trip was cancelled for whatever reason (no-show, app-cancellation, etc...). This is because the only way to determine the trip was cancelled is to go into the mode-specific trip attributes and infer the cancellation from the cancellation_reason field being not-empty (as of today, only an unnormalized string of text).

=> We suggest to add a trip_cancelled boolean as part of the root trip object so that the cancellation can be determined a lot easier. In this case, fields such as distance, duration, etc... could be made optional when trip has been cancelled for whatever reason.

This could be made mode-specific if some other mode do not need such a field.

PS: See issue #888 for our take on the mode-specific attributes and how we suggest to structure them.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the trip object definition and issue #888, then determine whether cancellation belongs on the root object or in mode-specific attributes. Define how the boolean interacts with optional fields such as distance and duration, and ensure the specification gives one unambiguous way to identify cancelled trips.

Written by the indexing model from the issue text.

Assessment

Domain
api, data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.