GitbookIO / GitbookIO/gitbook

Search API endpoint doesn't give results

Open
#3,278 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug triage
Dominant language
TypeScript
Stars
29k
Forks
4k
Avg merge
1d 2h
Merged PRs (30d)
71

Description

Bug description

The following endpoint seems to not always give results:

GET https://api.gitbook.com/v1/spaces/{spaceId}/search?query={question}

As an example, if the question is "custom hatch patterns", there are no results in the response. But, if the question is "hatch patterns", we get the expected results. The "no results" behavior seems to happen every time there is at least one word that doesn't match the possible results. This is not ideal in cases a user may add an extra word in there for context. Would it be possible to make this search engine for this endpoint not so sensitive?

Thank you

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 locating the implementation and tests for GET /v1/spaces/{spaceId}/search, then reproduce the difference between “custom hatch patterns” and “hatch patterns.” Done means queries containing an extra unmatched word still return the relevant results, with tests covering both examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, search
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.