pelias / pelias/documentation

Please document how to import intersections and query them

Open
#280 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
No language data
Stars
269
Forks
104
PR merge metrics
No merged PRs in 30d

Description

Hello, I am actively trying to import an intersection layer into pelias to query.
Per documentation you can query with
http://10.11.34.81:4000/v1/search?layers=intersection&size=1&text=London

But I get
{"geocoding":{"version":"0.2","attribution":"http://10.11.34.81:4000/attribution","query":{"text":"London","size":1,"private":false,"lang":{"name":"English","iso6391":"en","iso6393":"eng","via":"header","defaulted":false},"querySize":20,"parser":"pelias","parsed_text":{"subject":"London","locality":"London"}},"errors":["'intersection' is an invalid layers parameter. Valid options: coarse,address,street,postalcode,locality,neighbourhood,localadmin,county,region,macrohood,borough,country,dependency"],"engine":{"name":"Pelias","author":"Mapzen","version":"1.0"},"timestamp":1644613839421},"type":"FeatureCollection","features":[]}

Which is reflective of me not having the layer or building it?

Please document a workflow for adding in intersection data and querying.

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

Use the issue's reported invalid-layers response and requested import workflow as the starting point. Review the existing Pelias documentation structure to find where layer-import and query guidance belongs, then document the prerequisites, import steps, and intersection query workflow; done means a reader can follow the workflow and understand the reported error.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.