Initial thoughts around API, DB layer.
This commit is contained in:
31
api/api.txt
Normal file
31
api/api.txt
Normal file
@@ -0,0 +1,31 @@
|
||||
Personal Measure API
|
||||
====================
|
||||
|
||||
### Measure
|
||||
|
||||
☐ GET /measure Get a list of all defined measures for this user.
|
||||
☐ POST /measure Create a new measure (post the definition).
|
||||
☐ GET /measure/<measure-slug> Get the definition for a specific measure.
|
||||
☐ DELETE /measure/<measure-slug> Delete a measure (and all values associated with it).
|
||||
|
||||
### Values
|
||||
|
||||
☐ GET /<measure-slug> Get a list of values for a measure.
|
||||
☐ POST /<measure-slug> Add a new value for a measure.
|
||||
☐ GET /<measure-slug>/<id> Get the details for a specific value by id.
|
||||
☐ PUT /<measure-slug>/<id> Update a value by id.
|
||||
☐ DELETE /<measure-slug> Delete a value by id.
|
||||
|
||||
### Auth
|
||||
|
||||
☐ GET /auth-token Given a valid username/password combo, get an auth token.
|
||||
☐ GET /user Given a valid auth token, return the user details.
|
||||
☐ PSOT /app-token With a valid session, create a new app token.
|
||||
|
||||
Legend
|
||||
------
|
||||
|
||||
☐ TODO
|
||||
☑ Done
|
||||
☒ Will not do
|
||||
|
||||
Reference in New Issue
Block a user