Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Discussion: entry point name for componentized geocoding #455
We'll soon be releasing componentized geocoding to production and we'd like some input from our users. Conceptually, component geocoding is geocoding/searching using inputs that are already split up. Currently Pelias only supports 1box geocoding where an text analysis engine has to split, say,
With componentized geocoding, the input has already been split up. An example request is (not live in prod at this moment):
This is theoretically easier since any potential errors introduced by the text analyzer have been obviated by putting the onus of parsing on the caller instead of on the geocoding service itself.
What we're looking for is input from our users on the entry point name for componentized geocoding. For testing purposes, we'll be deploying componentized geocoding to
As implied by the name "beta", we make no guarantees that beta features will provide consistent answers or even behave rationally as we work out the details. That is, don't develop long term solutions against beta endpoints. We'll be updating our release notes to reflect when features move from beta to supported production.
More details about componentized geocoding can be found here.
This is great. I can see this used as essentially a results filter - for an application catering to NYC residents, for example, you could still have the one input box, but all you need to do is ask for an address and feed the city and state automatically to the API. (Let me know if this wouldn't work this way?)
I don't have any good suggestions for endpoint names but my initial reaction is that "component" is not precise enough. I'll keep thinking about it though.
Just my opinion, I think some variation of '5 box' would be more specific. Component is a vague term that is used broadly in many contexts, whereas 5-box is specific to geocoding. Worst case scenario someone doesn't know what 5-box means, a little bit of explanation clears that up and does double duty explaining what you're doing by using that endpoint.