mapbox / mapbox/mapbox-java

Use uuid in Map Matching response

Open
#1,174 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
438
Forks
117
PR merge metrics
No merged PRs in 30d

Description

Soon the Map Matching API will start returning a uuid field for all successful map match requests.

Once this field is returned for all profiles we should start using it in MapboxJava and remove the placeholder here https://github.com/mapbox/mapbox-java/blob/aa126fcad9e7dba2f5b7f74c5a46291463d9b85e/services-matching/src/main/java/com/mapbox/api/matching/v5/MatchingResponseFactory.java#L73

In the meantime, while we transition to including the uuid in all responses, we could consider adding optional parsing of the uuid field that falls back gracefully to the placeholder string. This could be useful for responses like NoMatch or NoRoute that don't return a uuid either.

/cc @Guardiola31337

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in services-matching/src/main/java/com/mapbox/api/matching/v5/MatchingResponseFactory.java at the placeholder referenced in the issue, and inspect how Map Matching responses are parsed. Compare successful responses with NoMatch and NoRoute responses to determine the expected uuid handling. Done means the response uses the API uuid when present and retains graceful behavior when it is absent.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.