Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v4 ideas - simplifying the API #25

Open
4 tasks
gmaclennan opened this issue Sep 5, 2016 · 0 comments
Open
4 tasks

v4 ideas - simplifying the API #25

gmaclennan opened this issue Sep 5, 2016 · 0 comments
Milestone

Comments

@gmaclennan
Copy link
Member

gmaclennan commented Sep 5, 2016

I think we can simplify some of the API, and move higher-level API calls into a separate module, something like osm-p2p-api. This is where all the checks can take place to maintain data integrity (not deleting nodes that are part of a way etc.). Much of this work is already in digidem/osm-p2p-server/api.

  • Remove osm.create() - functionality is in osm.put().
  • Remove osm.getChanges() - this is not particularly useful, and the higher-level functionality is in the api from osm-p2p-server.
  • Merge osm.query() and osm.queryStream() to a single method that returns a stream when no callback is passed.
  • Change the property refs on ways to nodes to match OSM JSON format.
@gmaclennan gmaclennan added this to the v4 milestone Sep 5, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant