Trakl2014 / trakl

A platform helping you minimise your time in Auckland traffic.
http://challengepost.com/software/trakl
5 stars 0 forks source link

Architecture Discussion + Documentation #9

Open tharax opened 10 years ago

tharax commented 10 years ago

Interested in a broader discussion about how the different repos/bits of the software interact, and what their contracts with each other are.

surfjedi commented 10 years ago

Brilliant I was just going thru the code too. So I have assigned this to you Peter! This subject really should be on Peter, Daniel, and Don - since you guys wrote the API's. The rest of us were on other stuff during HACKAKL.

Here are some things we should have all in one doc:

  1. Which of the current routes will work?
  2. API end points for each server
  3. The response(or input) json per end point per verb
  4. Which of the transport API's it calls and what it needs
  5. other?

I saw some of it already in some places for the traffic-api, but not all of it..

surfjedi commented 10 years ago

Here's a start on postman api collection https://www.getpostman.com/collections/d76f4b172be6eb5d321d