Update event_type enum values to snake_case - #247
Conversation
|
Documentation available at: |
|
This may end up being a separate issue, but I notice that we have |
|
@botanize proposal in Contributors meeting 8/13: convert this PR to handle all enums so that snake case is adopted uniformly in the 2.0 release |
lauriemerrell
left a comment
There was a problem hiding this comment.
putting a request changes review on to indicate the need to update this to handle ALL enums
|
Here are the other enums in the spec right now.
|
|
In GTFS schedule I though those enums were numeric so the styling shouldn't matter? (Overall, I accept this change and don't have a strong concern about how the GTFS decision falls, but my vote would be for uniformity in TIDES) |
Summary
In addition to being a normative change (that requires data migration for existing TIDES implementations) this is also a breaking change. This change updates
passenger_events.event_typeenum values from 'Sentence case' with spaces to snake_case for improved code compatibility.Resolves #235
Changes
spec/passenger_events.schema.jsonupdatedevent_typeenum from Sentence case to snake_case. Note: In addition to the snake_case conversion, this PR also removes unnecessary characters/words from several of the enum values for the sake of conciseness. I am eager from TIDES Contributors for input on those modifications. Here are all enum value changes:Vehicle arrived at stop-->vehicle_arrived,Vehicle departed stop-->vehicle_departedDoor opened-->door_openedDoor closed-->door_closedPassenger boarded-->passenger_boardedPassenger alighted-->passenger_alightedKneel was engaged-->kneel_engagedKneel was disengaged-->kneel_disengagedRamp was deployed-->ramp_deployedRamp was raised-->ramp_raisedRamp deployment failed-->ramp_failedLift was deployed-->lift_deployedLift was raised-->lift_raisedIndividual bike boarded-->bike_boardedIndividual bike alighted-->bike_alightedBike rack deployed-->bike_rack_deployedCHANGELOG.mdadded BREAKING change entry under[Unreleased]sectionReason for this change
The original 'Sentence case' enum values with spaces (e.g.,
"Vehicle arrived at stop") create unnecessary friction for some data manipulation operations in code. Values formatted in this way must be quoted in queries, cannot be used as variable names, and require case handling.The new snake_case format (
vehicle_arrived) will yield improvements including:WHEREclauses- For reference, see related discussion in Issue #235 and Fall 2025 TIDES Issues Working Group notes from December 1 and December 10.
Review checklist
Per change management policy, the following must be met before feature branch changes can merge to
developbranch:Community review status (updated August 27, 2026)
How community review works: Per the TIDES Change Management Policy, a proposal moves forward once at least three TIDES Contributors outside the originating working group publicly comment with a score: Accepted, Accepted with minor changes, or Substantially revised. A few sentences with your read of the proposal is a complete review.
Originating working group (Fall 2025 Issues Working Group, December 1 and 10, 2025 sessions): Christopher Yamas, Gabriel Sánchez Martínez, Ian Thistle, Jay Gordon, John Levin, Joey Reid, Spenser Sutinen. Their work is reflected in the proposal itself; community review comes from Contributors beyond this group.
Review so far: @lauriemerrell has accepted this change and supports extending snake_case to all enums; that scope question is being resolved with the Board Coordinator. Further scored reviews welcome.
Thanks to everyone who has weighed in on this proposal; it is moving into final consideration for v2.0. Further comments are always welcome.