Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the need to use graphQL alias for leg id when querying id an… #6243

Merged
merged 3 commits into from
Nov 8, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -670,8 +670,10 @@ type Leg {
"""
headsign: String
"""
An identifier for the leg, which can be used to re-fetch transit leg information.
An identifier for the leg, which can be used to re-fetch transit leg information, except leg's fare products.
Re-fetching fails when the underlying transit data no longer exists.
**Note:** when both id and fare products are queried, id should be queried using a suitable graphQL alias
vesameskanen marked this conversation as resolved.
Show resolved Hide resolved
such as `legId`. Relay does not accept different fare product ids in otherwise identical legs.
"""
id: String
"""
Expand Down Expand Up @@ -1173,6 +1175,7 @@ type QueryType {
"""
Try refetching the current state of a transit leg using its id.
This fails when the underlying transit data (mostly IDs) has changed or are no longer available.
Fare products cannot be refetched using this query.
"""
leg(id: String!): Leg
"""
Expand Down
Loading