Skip to content

Un-deprecate GTFS API's planConnection, deprecate plan #6110

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

Merged

Conversation

leonardehrenfried
Copy link
Member

@leonardehrenfried leonardehrenfried commented Oct 2, 2024

Summary

Deprecates the plan query and un-deprecates planConnection which has been used by HSL in production for several month.

Issue

#4803

Unit tests

I moved most of the integration tests from plan to planConnection. A single test for plan remains.

Documentation

The tutorial was updated with the new query.

Also, I added a CSS override so that the deprecated queries no longer show up in our HTML documentation of the schema.

@leonardehrenfried leonardehrenfried requested a review from a team as a code owner October 2, 2024 09:44
@leonardehrenfried leonardehrenfried changed the title Plan connection Un-deprecate GTFS API's planConnection, deprecate plan Oct 2, 2024
@leonardehrenfried leonardehrenfried added the Improvement A functional improvement label Oct 2, 2024
Copy link

codecov bot commented Oct 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.84%. Comparing base (90a5ebb) to head (550e8ba).
Report is 31 commits behind head on dev-2.x.

Additional details and impacted files
@@              Coverage Diff              @@
##             dev-2.x    #6110      +/-   ##
=============================================
- Coverage      69.85%   69.84%   -0.02%     
+ Complexity     17468    17457      -11     
=============================================
  Files           1975     1973       -2     
  Lines          74614    74566      -48     
  Branches        7640     7637       -3     
=============================================
- Hits           52118    52077      -41     
+ Misses         19848    19841       -7     
  Partials        2648     2648              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@optionsome
Copy link
Member

We agreed that this can happen now.

vesameskanen
vesameskanen previously approved these changes Oct 4, 2024
Copy link
Member

@optionsome optionsome left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

walk-steps integration test still uses the old plan query

Comment on lines +6 to +11
/*
* Hide the deprecated queries from the left hand navigation panel.
*/
nav ul li .deprecated {
display: none;
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How are they displayed without this? I'm just wondering since sometimes we use the deprecated on experimental queries (like we did for planConnection in the past), and I'm not sure if we want to hide their existence completely.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

It removes them from the left hand navigation but you can still access them from the search and if you type in the URL.

@leonardehrenfried leonardehrenfried merged commit ebcffb4 into opentripplanner:dev-2.x Oct 8, 2024
5 checks passed
t2gran pushed a commit that referenced this pull request Oct 8, 2024
@t2gran t2gran added this to the 2.7 (next release) milestone Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement A functional improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants