mapbox / mapbox/mapbox-search-android

Street query type marked as reserved for internal and special use

Open
#260 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Kotlin
Stars
39
Forks
10
PR merge metrics
No merged PRs in 30d

Description

Environment

  • Search SDK Component (check at least one)
    • Core Search SDK (SearchEngine class, and etc.)
    • Offline Search SDK (OfflineSearchEngine class, and etc.)
    • Address Autofill SDK
    • Search UI SDK
  • Android OS version:
  • Devices affected:
  • Search SDK Version: 2.2.0
  • Included in project Maps SDK, Nav SDK versions if available:

Code examples

Observed behavior and steps

In com.mapbox.search.QueryType:

    /**
     * Street query type.
     *
     * Note: Supported for Single Box Search API only. Reserved for internal and special use.
     */
    @Reserved(SBS)
    STREET,

Expected behavior

Does this @Reserved annotation need to be revisited following the addition of ApiType.SEARCH_BOX? It seems we can use the street query type with the Search Box API.

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 com.mapbox.search.QueryType and the ApiType.SEARCH_BOX entry point. Check how STREET and the @Reserved(SBS) annotation are used for Search Box requests, then confirm whether the annotation matches the supported public behavior. Done means the restriction accurately reflects the API and any affected validation is consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin
Domain
api, mobile
Issue type
Bug
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.