Conversation
This comment was marked as outdated.
This comment was marked as outdated.
There was a problem hiding this comment.
Pull request overview
This PR expands and clarifies inline documentation across the GraphQL schema (including directions, GBFS, and census-related types) and regenerates the corresponding Go gqlgen models so that schema descriptions are reflected in generated code.
Changes:
- Expanded GraphQL descriptions for core scalars, root Query/Mutation, and many GTFS/GBFS/Directions/Census types and fields.
- Added richer narrative documentation for Census datasets/geographies/values and routing response structures.
- Regenerated
server/model/models_gen.goto incorporate updated schema docs into generated Go comments.
Reviewed changes
Copilot reviewed 4 out of 6 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| server/model/models_gen.go | Regenerated gqlgen models to include updated schema doc comments in Go output. |
| schema/graphql/schema.graphqls | Major expansion of inline docs across core schema types/inputs; includes one schema directive change to review. |
| schema/graphql/gbfs.graphqls | Added extensive GBFS type and field descriptions. |
| schema/graphql/directions.graphqls | Added extensive directions/routing type and field descriptions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -431,689 +611,1027 @@ type FeedVersionServiceLevel { | |||
| """ | |||
| An agency represents a single GTFS `agencies.txt` entity that was imported from a single feed version. The metadata, routes, etc., for an agency include only the data for that specific agency in that specific feed version. | |||
There was a problem hiding this comment.
The GTFS file name in this description appears incorrect: GTFS uses agency.txt (singular), not agencies.txt. Updating this avoids confusion for API consumers and aligns with the GTFS spec terminology used elsewhere in the schema docs.
| id: Int! | ||
| "OSM Way ID, if any, associated with this segment" | ||
| way_id: Int! @deprecated(reason: "Use SegmentPattern.way_id instead") | ||
| way_id: Int! |
There was a problem hiding this comment.
This field used to be marked deprecated (per the previous schema), but the @deprecated directive has been removed. If the deprecation is still intended, please restore the directive (and reason) to avoid signaling to clients that Segment.way_id is a recommended long-term field again.
| way_id: Int! | |
| way_id: Int! @deprecated(reason: "Use the segment geometry and associated shapes instead of OSM way IDs.") |
No description provided.