deobhushan88 / fleaparking

Repository for fleaparking app and backend
0 stars 0 forks source link

Finalize and document all APIs #9

Closed deobhushan88 closed 9 years ago

deobhushan88 commented 9 years ago

Description Final, stable API documentation is required for developing the backend, and for the app developers to know what data structure they will be consuming.

Acceptance Criteria

  1. API documentation is available on the wiki for the following services. While developing the documentation, some of these services may be merged into one, split or removed if that makes for a good design.
  2. Also remember to consider where all types of operations are required (CRUD).
  3. Refer to corresponding story to figure out what data is required to be exchanged.
    • [ ] Register a new user
    • [ ] Provide credit card information to pay for parking space
    • [ ] Recover forgotten password
    • [ ] Enable/Disable all types of notifications
    • [ ] Edit personal information
    • [ ] Edit outgoing credit card payment information
    • [ ] Logout
    • [ ] Permanently close account
    • [ ] Help and documentation pages
    • [ ] Add a parking space
    • [ ] Delete a parking space
    • [ ] Make parking space available for rent
    • [ ] Change availability of parking space
    • [ ] Set price per unit time for each parking space
    • [ ] Provide incoming bank account details to receive payments
    • [ ] Edit incoming bank account details
    • [ ] Add feedback about parkers
    • [ ] View parking history at a parking space
    • [ ] Find currently available parking spaces around my location
    • [ ] Search available parking spaces around a specified location
    • [ ] Prebook a parking space
    • [ ] Cancel or edit booking times of a particular parking space
    • [ ] Check in to a parking space
    • [ ] Check out of a parking space
    • [ ] Provide multiple credit card information to the system
    • [ ] Remove a particular credit card from the system
    • [ ] Leave feedback about a parking space
    • [ ] See parking history of places where I have parked
    • [ ] Login to account
deobhushan88 commented 9 years ago

Done. Documented all APIs on the wiki.