Skip to content

Remove REST API #6578

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
merged 13 commits into from
Apr 4, 2025
Merged

Conversation

VillePihlava
Copy link
Contributor

@VillePihlava VillePihlava commented Mar 27, 2025

Summary

This PR removes the REST API and changes some related documentation. This is somewhat related to the ongoing effort to remove the old debug UI in PR #6478.

The snapshot tests require some of the mapping code. This PR preserves this functionality and moves the mapper code to the test scope. Lets discuss in the dev meeting if that is what we want.

Issue

N/A

Unit tests

N/A

Documentation

Files changed:

  • doc/user/Configuration.md
  • doc/user/apis/Apis.md

@VillePihlava VillePihlava requested a review from a team as a code owner March 27, 2025 07:52
Copy link

codecov bot commented Mar 27, 2025

Codecov Report

Attention: Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.

Project coverage is 70.97%. Comparing base (c418593) to head (6085219).
Report is 97 commits behind head on dev-2.x.

Files with missing lines Patch % Lines
...opentripplanner/ext/geocoder/GeocoderResource.java 0.00% 2 Missing ⚠️
Additional details and impacted files
@@              Coverage Diff              @@
##             dev-2.x    #6578      +/-   ##
=============================================
+ Coverage      70.31%   70.97%   +0.65%     
+ Complexity     18403    18236     -167     
=============================================
  Files           2088     1997      -91     
  Lines          77421    75763    -1658     
  Branches        7841     7768      -73     
=============================================
- Hits           54438    53772     -666     
+ Misses         20212    19259     -953     
+ Partials        2771     2732      -39     

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

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@optionsome
Copy link
Member

@leonardehrenfried was it that we could also remove the Message_<lang>.properties files now?

@leonardehrenfried
Copy link
Member

No, because of this:

@Override
public DataFetcher<String> description() {
return environment ->
PlannerErrorMapper.mapMessage(getSource(environment)).message.get(getLocale(environment));
}

@optionsome
Copy link
Member

What should we do about the data overlay feature as I think it was only usable through the REST API. I think @t2gran once mentioned entur might use it for something in the future so maybe we will keep it.

@leonardehrenfried
Copy link
Member

A data point about this feature: I emailed the original authors a few weeks ago but never received a response. I suspect they don't work for that company anymore.

@optionsome
Copy link
Member

LocationStringParser, QualifiedModeSet, DebugOutput, TransitTimingOutput, GraphQLResponseSerializer, Direction, SnapshotTestBase, SystemErrDebugLogger have some REST API related documentation that should be removed. You should also check if these classes are still needed as whole/at all.

apiProcessingTimeout config parameter doc has reference to the REST API.

BuildConfiguration.md has documentation about Geoid Difference which has a link to a removed rest API class, perhaps the documentation is not relevant anymore? Configuration.md Config version section has a reference to the REST API. Developers-Guide.md has reference to rest API in the release process doc. Version-Comparison.md Routing request parameters section has reference to rest API.

There is a package called org.opentripplanner.routing.algorithm.mapping.restapi

RestAPIPassInDefaultConfigAsJson feature flag can be removed.

Copy link
Contributor

Choose a reason for hiding this comment

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

Good riddance!

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.

TransitTimingOutput and SystemErrDebugLogger should still be updated.

@VillePihlava VillePihlava merged commit e969743 into opentripplanner:dev-2.x Apr 4, 2025
6 checks passed
t2gran pushed a commit that referenced this pull request Apr 4, 2025
@leonardehrenfried leonardehrenfried deleted the remove-rest branch April 4, 2025 07:07
@leonardehrenfried
Copy link
Member

Lets us have a minute's silence after the REST API has gone to the great big JVM in the sky.

REST in peace.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants