diff options
| author | JocelynDelalande <JocelynDelalande@users.noreply.github.com> | 2017-12-21 13:56:25 +0100 |
|---|---|---|
| committer | Alexis Metaireau <alexis@notmyidea.org> | 2017-12-21 13:56:25 +0100 |
| commit | 0dfb9c5f948b10857ce5b55b6317c7773dab87b0 (patch) | |
| tree | f1c404d09209b26e86f5d29689ad950e6529fd35 /docs/api.rst | |
| parent | 8a68ac0d5b85f896dd59042c207bc63c3d026f7d (diff) | |
| download | ihatemoney-mirror-0dfb9c5f948b10857ce5b55b6317c7773dab87b0.zip ihatemoney-mirror-0dfb9c5f948b10857ce5b55b6317c7773dab87b0.tar.gz ihatemoney-mirror-0dfb9c5f948b10857ce5b55b6317c7773dab87b0.tar.bz2 | |
Add missing properties in API docs (#287)
* Mention weights in API doc
Because this is reality :-)
* Mention balance property in API doc
Still because this is reality.
Diffstat (limited to 'docs/api.rst')
| -rw-r--r-- | docs/api.rst | 32 |
1 files changed, 19 insertions, 13 deletions
diff --git a/docs/api.rst b/docs/api.rst index 9fc9cc6..b82c6f3 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -65,14 +65,20 @@ Getting information about the project:: "contact_email": "demo@notmyidea.org", "password": "demo", "id": "demo", - "active_members": [{"activated": true, "id": 31, "name": "Arnaud"}, - {"activated": true, "id": 32, "name": "Alexis"}, - {"activated": true, "id": 33, "name": "Olivier"}, - {"activated": true, "id": 34, "name": "Fred"}], - "members": [{"activated": true, "id": 31, "name": "Arnaud"}, - {"activated": true, "id": 32, "name": "Alexis"}, - {"activated": true, "id": 33, "name": "Olivier"}, - {"activated": true, "id": 34, "name": "Fred"}], + "active_members": [{"activated": true, "weight": 1, "id": 31, "name": "Arnaud"}, + {"activated": true, "weight": 1, "id": 32, "name": "Alexis"}, + {"activated": true, "weight": 1, "id": 33, "name": "Olivier"}, + {"activated": true, "weight": 1, "id": 34, "name": "Fred"}], + "members": [{"activated": true, "weight": 1, "id": 31, "name": "Arnaud"}, + {"activated": true, "weight": 1, "id": 32, "name": "Alexis"}, + {"activated": true, "weight": 1, "id": 33, "name": "Olivier"}, + {"activated": true, "weight": 1, "id": 34, "name": "Fred"}], + "balance": { + "31": 6.0, + "32": 6.0 + "33": -6.0 + "34": -6.0 + } } @@ -98,10 +104,10 @@ Members You can get all the members with a `GET` on `/api/projects/<id>/members`:: $ curl --basic -u demo:demo https://ihatemoney.org/api/projects/demo/members\ - [{"activated": true, "id": 31, "name": "Arnaud"}, - {"activated": true, "id": 32, "name": "Alexis"}, - {"activated": true, "id": 33, "name": "Olivier"}, - {"activated": true, "id": 34, "name": "Fred"}] + [{"weight": 1, "activated": true, "id": 31, "name": "Arnaud"}, + {"weight": 1, "activated": true, "id": 32, "name": "Alexis"}, + {"weight": 1, "activated": true, "id": 33, "name": "Olivier"}, + {"weight": 1, "activated": true, "id": 34, "name": "Fred"}] Add a member with a `POST` request on `/api/projects/<id>/members`:: @@ -114,7 +120,7 @@ You can also `PUT` a new version of a member (changing its name):: $ curl --basic -u demo:demo -X PUT\ https://ihatemoney.org/api/projects/demo/members/36\ -d 'name=yeaaaaah' - {"activated": true, "id": 36, "name": "yeaaaaah"} + {"activated": true, "id": 36, "name": "yeaaaaah", "weight": 1} Delete a member with a `DELETE` request on `/api/projects/<id>/members/<member-id>`:: |