mapbox / mapbox/mapbox-navigation-android
Improve route request error body information
Nobody has claimed this yet.
- Dominant language
- Kotlin
- Stars
- 651
- Forks
- 321
- PR merge metrics
- No merged PRs in 30d
Description
When the RouterFailure is generated for an offboard router, we append the whole JSON error body as RouterFailure.message. If someone would like to get the code and message of the error iteslf programmatically, they would have to deserialize the JSON and fetch the values themselves.
We currently do not document in the Nav SDK what's the schema of the error and how to deserialize it, and we probably should. Alternatively, we can go a step further and parse the error body ourselves and deliver objects instead of a serialized error body.
cc @Guardiola31337
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing where RouterFailure is generated for an offboard router and inspect the current Nav SDK error-body handling. The issue presents documentation, deserialization, and typed-object alternatives; confirm the intended direction before changing anything, with completion defined as programmatic access to the error code and message or documented deserialization.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kotlin
- Domain
- mobile
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100