Clarify event_count usage and APC data guidance#248
Open
chrisyamas wants to merge 2 commits intodevelopfrom
Open
Clarify event_count usage and APC data guidance#248chrisyamas wants to merge 2 commits intodevelopfrom
chrisyamas wants to merge 2 commits intodevelopfrom
Conversation
Contributor
|
Documentation available at: |
jlstpaul
approved these changes
Jan 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This change clarifies the
passenger_events.event_countfield documentation to provide guidance on proper usage, distinguishing between individual passenger events and aggregated APC counts.Resolves #236
Changes
spec/passenger_events.schema.jsonupdatedevent_countdescription to:0indicates a recorded event with no passengers, distinct from null/missing dataCHANGELOG.mdadded entry under[Unreleased]Reason for change
The original description was ambiguous about when to use
event_count > 1vs. recording aggregated data. Some TIDES implementers have noted the lack of clarity for whether to put APC summary data (for instance, "6 passengers boarded at this stop") intopassenger_eventsorstop_visits.This clarification establishes that
passenger_eventsis for discrete, instantaneous events, whilestop_visitsis the appropriate destination for aggregated counts.- For reference, see related discussion in Issue #236 and Fall 2025 TIDES Issues Working Group notes from December 1
Review checklist
Per TIDES change management policy, the following must be met before feature branch changes can merge to
developbranch: