jdb/personal-measure
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Implementation of /measure, /measurements APIs.

Browse Source
This commit is contained in:
Jonathan Bernard
2019-02-19 17:51:38 -06:00
parent 33eff538f8
commit 02e0d1cae1
9 changed files with 314 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
api/api.txt
View File

@@ -3,23 +3,27 @@ Personal Measure API
### Measure
☐ GET /measures Get a list of all defined measures for this user.
☐ POST /measures Create a new measure (post the definition).
☐ GET /measures/<measure-slug> Get the definition for a specific measure.
☐ DELETE /measures/<measure-slug> Delete a measure (and all values associated with it).
☑ GET /measures Get a list of all defined measures for this user.
☑ POST /measures Create a new measure (post the definition).
☑ GET /measures/<measure-slug> Get the definition for a specific measure.
☑ DELETE /measures/<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.
☑ GET /measure/<measure-slug> Get a list of measurements for a measure.
☑ POST /measure/<measure-slug> Add a new measurements for a measure.
☑ GET /measure/<measure-slug>/<id> Get the details for a specific measurements by id.
☐ PUT /measure/<measure-slug>/<id> Update a measurements by id.
☑ DELETE /measure/<measure-slug>/<id> Delete a measurements 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.
☑ POST /user Given a valid auth token for an admin user, create a new user account.
☑ DELETE /user Given a valid auth token for an admin user, delete a user account.
☑ POST /change-pwd Given a valid auth token and a valid password, change the password
☑ POST /change-pwd/<id> Given a valid auth token for an admin user change the given user's password
☑ GET /api-tokens List api tokens.
☑ DELETE /api-tokens/<id> Delete a specific api token.
☑ POST /api-tokens With a valid session, create a new api token.