pelias / pelias/api

Query filters for parent data fields

Open
#1,646 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
259
Forks
168
Avg merge
6h 15m
Merged PRs (30d)
1

Description

We can filter the results by country using pelias-api, by using the boundary.country query parameter which will target the country abbreviation field (country_a) under the parents.

We want to have the ability to filter on other parent fields also, may be on Ids instead of abbreviation field.

We are currently using the forked version of pelias-api where we have added ability to search on locality_id and county_id. But this is very specific to out needs.
We may find a general solution to filter on any parent field.

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 in pelias-api by tracing the boundary.country query parameter to the parent country_a field, then compare it with the fork's locality_id and county_id filtering. Define the general filtering scope before changing it; done means parent fields can be filtered consistently rather than through field-specific additions.

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
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.