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

feat: open up snapping endpoint in public API #1796

Merged
merged 8 commits into from
Jun 4, 2024

Conversation

aoles
Copy link
Member

@aoles aoles commented May 22, 2024

Pull Request Checklist

  • 1. I have rebased the latest version of the main branch into my feature branch and all conflicts
    have been resolved.
  • 2. I have added information about the change/addition to functionality to the CHANGELOG.md file under the
    [Unreleased] heading.
  • 3. I have documented my code using JDocs tags.
  • 4. I have removed unnecessary commented out code, imports and System.out.println statements.
  • 5. I have written JUnit tests for any new methods/classes and ensured that they pass.
  • 6. I have created API tests for any new functionality exposed to the API.
  • 7. If changes/additions are made to the ors-config.json file, I have added these to the ors config documentation
    along with a short description of what it is for, and documented this in the Pull Request (below).
  • 8. I have built graphs with my code of the Heidelberg.osm.gz file and run the api-tests with all test passing
  • 9. I have referenced the Issue Number in the Pull Request (if the changes were from an issue).
  • 10. For new features or changes involving building of graphs, I have tested on a larger dataset
    (at least Germany), and the graphs build without problems (i.e. no out-of-memory errors).
  • 11. For new features or changes involving the graphbuilding process (i.e. changing encoders, updating the
    importer etc.), I have generated longer distance routes for the affected profiles with different options
    (avoid features, max weight etc.) and compared these with the routes of the same parameters and start/end
    points generated from the current live ORS.
    If there are differences then the reasoning for these MUST be documented in the pull request.
  • 12. I have written in the Pull Request information about the changes made including their intended usage
    and why the change was needed.
  • 13. For changes touching the API documentation, I have tested that the API playground renders correctly.

Fixes # .

Information about the changes

  • Key functionality added:
    • adapt documentation to the new API endpoint
    • maximum_locations config parameter to snap endpoint
  • Reason for change: prepare to going live with the snapping endpoint.

@aoles aoles force-pushed the feat/open_up_snapping_endpoint branch from 14a1ce4 to 7a8f257 Compare May 23, 2024 10:37
aoles added a commit that referenced this pull request May 24, 2024
@aoles aoles marked this pull request as ready for review May 27, 2024 10:58
@github-actions github-actions bot added feature and removed feature labels May 27, 2024
@aoles aoles enabled auto-merge May 27, 2024 11:12
Copy link

sonarcloud bot commented Jun 4, 2024

@aoles aoles merged commit 94384f0 into main Jun 4, 2024
39 checks passed
@aoles aoles deleted the feat/open_up_snapping_endpoint branch June 4, 2024 14:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Awaiting release
Development

Successfully merging this pull request may close these issues.

4 participants