mapbox / mapbox/mapbox-sdk-js

GeocodingV6 missing full_address types & docs reference

Open
#481 0 comments 1 reaction 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

`GeocodingV6` returns `properties.full_address` & `properties.context.neighborhood`
on `forwardGeocode`, but there is no mention of it (full_address) in the [docs](https://docs.mapbox.com/api/search/geocoding-v6/) nor does [type reference](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/mapbox__mapbox-sdk/index.d.ts) (for both)

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 with the forwardGeocode response handling in this repository, then inspect the linked DefinitelyTyped index.d.ts and the Geocoding V6 documentation page. Confirm how properties.full_address and properties.context.neighborhood are represented, and consider the work done when both fields are accurately documented and included in the type reference.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.