v7.0.0

[emmambd]

Highlights

🧒 👵 👨 Rules for rider categories in GTFS-Fares

Rider Categories are groups of passengers, like adults, children, seniors, or students, who may get different fare pricing based on their age, status, or needs. As of February this year, it's now possible to describe rider categories in GTFS. We've added validation rules to check the quality of new rider categories data, as well as a new Rider Category Feature that will display in the summary report when this data is provided.

📞🚌 Full list of Flex rules

GTFS Flex is a proposal that ensures riders can discover demand responsive services and how to book them. Flex was officially adopted into GTFS last year. With this validator release, we offer a full list of validation rules for Flex. You can see more under "Flex notices".

Breaking JSON report change: N/A values now display as ""

To help standardize empty strings, empty values are now populated with "" instead of N/A in the generated report.json.

Notice changes

🔴 duplicate_key: Triggers when rider_category_id is not unique in rider_categories.txt.
🔴 foreign_key_violation: Verifies that

• every network_id found in fare_leg_join_rules.txt matches an entry in networks.txt or routes.txt.
• every rider_category_id found in fare_products.txt matches an entry in rider_categories.txt.

🔴 invalid_url: Triggers when eligibility_url in rider_categories.txt is invalid.

🔴 missing_required_field: Triggers when

• from_stop_id or to_stop_id is present in fare_leg_join_rules.txt but the other is omitted
• rider_category_id and/or rider_category_name and/or is_default_fare_category are omitted from rider_categories.txt

🔴 unexpected_enum_value: Triggers when is_default_fare_category is a value other than 0, empty or 1.
⬜ unused_parent_station renamed to unused_station

New notices

🔴 fare_product_with_multiple_default_rider_categories: This notice is generated when a fare product is associated with multiple rider categories that are marked as default.
🟡 transfer_distance_too_large: The transfer distance from stop to stop in transfers.txt is larger than 10 km.
⬜ transfer_distance_above_2_kmThe transfer distance from stop to stop in transfers.txt is larger than 2 km.

Flex notices

Flex new notices

🔴 duplicate_geography_id: ID must be unique across all stops.stop_id, locations.geojson id, and location_groups.location_group_id values.
🔴 forbidden_geography_id: In stop_times.txt, you can have only one of stop_id, location_group_id or location_id defined for given entry.
🔴 missing_stop_times_record: Travel within the same location group or GeoJSON location requires two records in stop_times.txt with the same location_group_id or location_id.
🔴 forbidden_arrival_or_departure_time: The arrival or departure times are provided alongside pickup or drop-off windows in stop_times.txt. This violates GTFS specification, as both cannot coexist for a single stop time record.
🔴 forbidden_continuous_pickup_drop_off: Continuous pickup or drop-off are forbidden when routes.continuous_pickup or routes.continuous_drop_off are 0, 2 or 3 and stop_times.start_pickup_drop_off_window or stop_times.end_pickup_drop_off_window are defined for any trip of this route.
🔴 forbidden_pickup_type: pickup_drop_off_window fields are forbidden when the pickup_type is regularly scheduled (0) or must be coordinated with the driver (3).
🔴 forbidden_drop_off_type: pickup_drop_off_window fields are forbidden when the drop_off_type is regularly scheduled (0).
🔴 invalid_pickup_drop_off_window: The end_pickup_drop_off_window must be strictly later than the start_pickup_drop_off_window.
🔴 missing_pickup_or_drop_off_window: Either the start or end pickup/drop-off window is missing in stop_times.txt.
🟡 missing_pickup_drop_off_booking_rule_id: pickup_booking_rule_id is recommended when pickup_type=2 and drop_off_booking_rule_id is recommended when drop_off_type=2. Currently, this notice is only triggered on feeds when either start_pickup_drop_off_window or end_pickup_drop_off_window is defined, since this recommendation was added to the specification for feeds with GTFS-Flex.

locations.geojson notices

🔴 duplicate_geo_json_key: The key must be unique for each feature in the GeoJSON file.
🔴 geo_json_duplicated_element: Duplicated elements in locations.geojson file.
🔴 overlapping_zone_and_pickup_drop_off_window: Two entities in stop_times.txt with the same trip_id have the same pickup_type or drop_off_type and overlapping pickup/drop-off windows and overlapping zones in locations.geojson.
⬜ geo_json_unknown_element: Unknown elements in locations.geojson file.

Flex notice changes

🔴 foreign_key_violation: Checks that the location_id field in stop_times.txt reference valid entries in the locations.geojson file.
🔴 missing_prior_day_booking_field_value separated into missing_prior_notice_last_day and missing_prior_notice_last_time notices

Impacts on existing data

You can find the impact of this release on all existing datasets we have in the Mobility Database in this spreadsheet.

Other notable improvements

• Documentation: Added website documentation on how the feed summary metadata report is extracted, available at https://gtfs-validator.mobilitydata.org/rules.html#summary-metadata.
• Published the Java GUI as a independent jar asset
• Bug: @sylvansson fixed issue where invalid_input_files_in_subfolder was not being triggered in certain valid cases.

New Contributors

• @sylvansson made their first contribution in feat: rename unused_parent_station rule to unused_station #1959
• @skalexch made their first contribution in docs: add Rider Categories to features #1981

Full PR List

• docs: Automated update of NOTICE_MIGRATION.md by @github-actions in docs: Automated update of NOTICE_MIGRATION.md #1905
• fix: filter out Continuous Stops from flex alert by @cka-y in fix: filter out Continuous Stops from flex alert #1920
• feat: Use a github variable containing 1password secret references by @jcpitre in feat: Use a github variable containing 1password secret references #1921
• chore: artifact action v3 upgrade by @cka-y in chore: artifact action v3 upgrade #1926
• chore: upgrade missed e2e upload artifact to v4 by @davidgamez in chore: upgrade missed e2e upload artifact to v4 #1937
• feat: 1822 flex forbidden pickup type & forbidden drop off type by @qcdyx in feat: 1822 flex forbidden pickup type & forbidden drop off type #1936
• fix: python scripts failing in ubuntu-latest GitHub workflows by @davidgamez in fix: python scripts failing in ubuntu-latest GitHub workflows #1944
• feat: pickup and drop off window validator by @cka-y in feat: pickup and drop off window validator #1935
• feat: 1820 flex missing stop times record by @qcdyx in feat: 1820 flex missing stop times record #1945
• feat: flex - overlapping_zone_and_pickup_drop_off_window by @cka-y in feat: flex - overlapping_zone_and_pickup_drop_off_window #1934
• feat: stop_times.txt and locations.geojson foreign key validation by @cka-y in feat: stop_times.txt and locations.geojson foreign key validation #1951
• feat: added agencyTimezone to JSON report summary by @cka-y in feat: added agencyTimezone to JSON report summary #1946
• feat: 1814 flex forbidden continuous pickup or drop off by @qcdyx in feat: 1814 flex forbidden continuous pickup or drop off #1941
• feat: 1927 flex geo json parsing failed by @qcdyx in feat: 1927 flex geo json parsing failed #1947
• feat: java support for sdk17 by @davidgamez in feat: java support for sdk17  #1952
• feat: duplicate_geography_id, duplicate_geo_json_key and forbidden_geography_id notices by @cka-y in feat: duplicate_geography_id, duplicate_geo_json_key and forbidden_geography_id notices #1953
• feat: added fare_leg_join_rules.txt schema and validation by @cka-y in feat: added fare_leg_join_rules.txt schema and validation #1956
• feat: rename unused_parent_station rule to unused_station by @sylvansson in feat: rename unused_parent_station rule to unused_station #1959
• feat: removed missing_recommended_column and related annotation + changed missing_timepoint_value notice description by @cka-y in feat: removed missing_recommended_column and related annotation + changed missing_timepoint_value notice description #1963
• feat: removed Flex notice on report by @qcdyx in feat: removed Flex notice on report #1967
• fix: sort expired_calendar notices by row number by @sylvansson in fix: sort expired_calendar notices by row number #1968
• feat: added dynamic fields for point near origin and poles by @cka-y in feat: added dynamic fields for point near origin and poles #1965
• feat: 1929 duplicated element by @qcdyx in feat: 1929 duplicated element #1970
• fix: fix logic to check for nested GTFS files in ZIP by @sylvansson in fix: fix logic to check for nested GTFS files in ZIP #1972
• feat: 1930 unknown geojson element by @qcdyx in feat: 1930 unknown geojson element #1973
• fix: 1725 inconsistent dependency versions across modules by @qcdyx in fix: 1725 inconsistent dependency versions across modules #1978
• feat: update docs for invalid_input_files_in_subfolder by @sylvansson in feat: update docs for invalid_input_files_in_subfolder #1983
• feat: implemented transfer distance validator by @cka-y in feat: implemented transfer distance validator #1958
• feat: added support + automated documentation extraction for summary metadata by @cka-y in feat: added support + automated documentation extraction for summary metadata #1974
• feat: added missing_pickup_booking_rule_id notice by @cka-y in feat: added missing_pickup_booking_rule_id notice #1966
• feat: added GtfsRiderCategoriesSchema by @qcdyx in feat: added GtfsRiderCategoriesSchema #1989
• feat: add deprecated notices to documentation by @cka-y in feat: add deprecated notices to documentation #1990
• docs: add Rider Categories to features by @skalexch in docs: add Rider Categories to features #1981
• feat: added rider categories feature by @cka-y in feat: added rider categories feature #1995
• feat: duplicate key notice dynamic fieldName and fieldValue by @cka-y in feat: duplicate key notice dynamic fieldName and fieldValue #1994
• feat: separate out missing_prior_day_booking_field_value by @cka-y in feat: separate out missing_prior_day_booking_field_value #1996
• feat: 1976 modifying notice description for invalid currency amount by @qcdyx in feat: 1976 modifying notice description for invalid currency amount #1988
• feat: publish the Java GUI as a independent jar asset by @davidgamez in feat: publish the Java GUI as a independent jar asset #2000
• fix: update MissingPriorNoticeLastDayNotice and MissingPriorNoticeLastTimeNotice documentation by @davidgamez in fix: update MissingPriorNoticeLastDayNotice and MissingPriorNoticeLastTimeNotice documentation #2002
• feat: modified MissingPickupDropOffBookingRuleIdNotice logic by @qcdyx in feat: modified MissingPickupDropOffBookingRuleIdNotice logic #2001
• feat: 1980 add fare product with multiple default rider categories by @qcdyx in feat: 1980 add fare product with multiple default rider categories #1998
• feat: standardize empty value on report.json by @davidgamez in feat: standardize empty value on report.json #2004

Full Changelog: v6.0.0...v7.0.0

---

This discussion was created from the release v7.0.0.