add StopInPattern in GTFS GraphQL schema #6206
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## dev-2.x #6206 +/- ##
==========================================
Coverage 69.79% 69.79%
- Complexity 17786 17788 +2
==========================================
Files 2017 2019 +2
Lines 76042 76056 +14
Branches 7781 7782 +1
==========================================
+ Hits 53073 53084 +11
- Misses 20264 20267 +3
Partials 2705 2705 ☔ View full report in Codecov by Sentry. |
|
@optionsome We discussed before about the use of Pattern in the API and your use case is to show timetables in the app, which you don't want to take real time stop skipping into account (it modifies the pattern in our internal model). Are you actually showing the real time timetable (with updated times) on the website, or just the scheduled time? How do you deal with the case if a trip is real time diverted? |
|
We may need to verify the current API behaviour by making a data set with patterns differing in only the board and alight actions. |
|
I am republishing this PR for discussion. Our existing GTFS GraphQL API distinguish between patterns which differ only in pickup / drop off and they are listed separately in |
I just checked this and looks like you are correct. |
| @@ -901,6 +901,8 @@ type Pattern implements Node { | |||
| semanticHash: String | |||
| "List of stops served by this pattern" | |||
| stops: [Stop!] | |||
| "List of stops with pickup / dropoff type served by this pattern" | |||
| stopsInPattern: [StopInPattern!]! | |||
There was a problem hiding this comment.
What do you need this for? Is it just for the index? Isn't it straightforward to compute the index yourself, first item in the list is 0 and so on?
| @@ -2172,6 +2174,16 @@ type StopGeometries { | |||
| googleEncoded: [Geometry] | |||
| } | |||
|
|
|||
| type StopInPattern { | |||
| "NULL means that the stop is cancelled from the pattern." | |||
| dropoffType: PickupDropoffType | |||
There was a problem hiding this comment.
| dropoffType: PickupDropoffType | |
| dropOffType: PickupDropoffType |
| "NULL means that the stop is cancelled from the pattern." | ||
| dropoffType: PickupDropoffType | ||
| indexInPattern: Int! | ||
| pattern: Pattern! |
There was a problem hiding this comment.
Do you need the pattern? Seems like you already have it.
Summary
This adds a field called
stopsInPatternin thePatternmodel for the GTFS GraphQL API.It provides information which cannot be accessed by the existing API, in particular, the board / alight types of stops in a pattern.
Issue
None yet.
Unit tests
The data fetcher code is not tested at all.
I have added a test for the model constructions.
Documentation
Added in GraphQL.
Note that NULL is used for a cancelled
PickDropto be consistent with existing API. It is not possible to change this without breaking backwards compatibility.