search

libremap / libremap-api

The CouchDB server design document for LibreMap - a scalable, global and decentralized router database and map visualization for community networks, such as guifi, AlterMundi, FunkFeuer, ninux, freifunk, Commotion...
http://libremap.net/
GNU General Public License v3.0
10 stars 6 forks source link

pluralize endpoint name(s) #3

Open booo opened 10 years ago

booo commented 10 years ago

Just skimmed the api documentation [1] and I think you should puralize? the endpoint name for router to api/routers. If there are or will be other endpoints you should also rename them.

A maybe good resource for arguments:

http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api

Maybe it's also worth to think about the routers_by_location resource? Just brain storming:

I understand that this is a very subjective topic but there are some conventions that most people try to follow and maybe we should try to do so too.

Thanks for your ongoing hard work on the topic! Nice work!!!

Best Regards Philipp

[1] https://github.com/libremap/libremap-api/blob/master/doc-api.md