Add mapbox directions route - #43
Open
mattpodwysocki wants to merge 2 commits into
Open
mattpodwysocki wants to merge 2 commits into
mattpodwysocki wants to merge 2 commits into
Conversation
The Navigation API category (Directions, Isochrone, Map Matching, Matrix, Optimization, EV Charge Finder) has had no CLI coverage — this is the first of those, hand-authored into custom-openapi/ since openapi-specs publishes no spec for it yet. Excludes the ~30 electric-vehicle-routing parameters (engine=electric and everything under it): those describe a vehicle's charging curve down to the watt, which an integration passes in from a vehicle profile rather than something to hand-type as a CLI flag. The EV Charge Finder API is a better fit for that case. Also excludes POST, which this spec format has no way to express alongside GET for the same operation — a real gap for a very long coordinate list, not a design choice. Two path-parameter bugs surfaced while wiring this up, fixed generically rather than just for this command: - A spec parameter literally named `profile` (the routing profile, mapbox/driving etc.) silently collided with the global --profile credentials flag — clap has one namespace of ids per command, and the generated positional replaced the global one outright instead of erring. `mapbox directions route mapbox/driving …` failed with `Invalid profile name "mapbox/driving"` before this. Fixed with a small, documented arg-name override table (ARG_NAME_OVERRIDES), the same shape BODY_CONTENT_TYPE_OVERRIDES already uses. - An enum-constrained path parameter whose only valid values contain a literal `/` (again, mapbox/driving) was being percent-encoded to %2F by the same escaping that stops a free-text path parameter from smuggling in extra path segments or retargeting the request. Safe to skip once clap's PossibleValuesParser has already limited the value to one of the spec's own literal strings — there is nothing left for a caller to inject. Smoke-tested against production: real routes for driving and walking profiles, with --steps, --geometries geojson, --overview full, and --annotations all verified to return the documented shape. 621 tests, fmt and clippy clean. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
first_sentence() in src/main.rs cuts a --help line at the first '.', which is right after "`mapbox/driving` only" or "`mapbox/driving` and `mapbox/driving-traffic`" on eight parameters here — a real sentence on its own that was eating everything substantive that followed it in --help. --schema and docs/commands.md were never affected; they show the full text. Fixed by moving the profile-scope note to the end of each description instead of the front, so the useful part survives the cut. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This was referenced Sep 23, 2026
This sentence doesn't make a lot of sense. The EV Charge Finder API is for finding charging stations. The Please make sure to validate that the vibe-coding here is reviewed by folks that know the APIs properly - it seems that the LLM is coming to some faulty conclusions somehow. |
danpat
reviewed
Sep 24, 2026
| #### Parameters | ||
|
|
||
| `<routing-profile>` and `<coordinates>` (both positional) are required. | ||
| `<routing-profile>` is one of `mapbox/driving-traffic`, `mapbox/driving`, |
There was a problem hiding this comment.
For some of our OEM customers, this is not true - but we don't publish any of those additional profiles.
danpat
reviewed
Sep 24, 2026
| schema: | ||
| type: number | ||
| minimum: 1 | ||
| maximum: 1000 |
There was a problem hiding this comment.
What if we change this server-side to something bigger?
This was referenced Sep 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
mapbox directions route— the first command for the Navigation APIcategory (Directions, Isochrone, Map Matching, Matrix, Optimization, EV
Charge Finder), none of which had CLI coverage before this. Hand-authored
into
custom-openapi/since openapi-specs publishes no spec for theDirections API yet, following the same convention
searchalready uses.Routes between 2-25 waypoints for driving (with or without live traffic),
walking, or cycling.
Excluded on purpose:
engine=electricandeverything under it) — those describe a vehicle's charging curve down to
the watt, which an integration passes in from a vehicle profile rather
than something to hand-type as a CLI flag. The EV Charge Finder API is a
better fit for that case.
choice" for the same operation. A real gap for a very long coordinate
list, not a design choice; noted in the spec's own header for whoever
picks it up.
Two path-parameter bugs found and fixed generically
Both surfaced from
profile's value (mapbox/drivingetc.) containing aliteral
/— not specific to this command, so fixed for every command:profilesilently collided with the global--profilecredentials flag. Clap has one namespace of ids percommand; the generated positional replaced the global one outright
instead of erring, so
mapbox directions route mapbox/driving …failedwith
Invalid profile name "mapbox/driving". Fixed with a small,documented override table (
ARG_NAME_OVERRIDESinsrc/spec.rs), sameshape as the existing
BODY_CONTENT_TYPE_OVERRIDES.same escaping that stops a free-text path parameter from smuggling in
extra path segments (
../../tokens/v2/victimetc.) was turningmapbox/driving's/into%2F, a 404. Safe to skip once clap'sPossibleValuesParserhas already limited the value to one of thespec's own literal strings — nothing left to inject. New
path_segment_forin
src/executor.rs, unit-tested against both the enum and non-enumcases.
Verification
Smoke-tested against production, not just unit tests — real routes for
mapbox/drivingandmapbox/walking, with--steps,--geometries geojson,--overview full, and--annotationsall verified to return thedocumented shape. Full transcript and captured response are in
docs/commands.md's new section.621 tests,
cargo fmt --checkandcargo clippy --all-targets -- -D warningsboth clean.Not done
The other five Navigation-category APIs (Isochrone, Map Matching, Matrix,
Optimization, EV Charge Finder) and Places/Feedback are tracked as separate
follow-ups, not bundled into this PR.
🤖 Generated with Claude Code