mapbox / mapbox/mapbox-sdk-js

Arbitrary geocoding arguments

Open
#311 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
768
Forks
191
PR merge metrics
No merged PRs in 30d

Description

Currently the arguments passed to the geocoding service are relatively controlled and limited. While this prevents unexpected behavior from adding invalid/unknown arguments to the geocoding api, it also introduces a barrier to adopting new api features (such as routable points]. Do we want to keep arguments to the service tightly scoped or could we modify https://github.com/mapbox/mapbox-sdk-js/blob/master/services/geocoding.js to accept arbitrary new arguments?

\cc @danswick @katydecorah @yuletide

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 by reading services/geocoding.js and the linked Mapbox forward-geocoding documentation, including the routable points feature. Determine whether the service should continue restricting arguments or accept new API parameters, and define the expected behavior before considering implementation. Done means the project has a decided, verifiable approach for handling new geocoding arguments.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.