almet/ihatemoney
1
0
Fork 0
mirror of https://github.com/spiral-project/ihatemoney.git synced 2025-04-29 01:42:37 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add missing properties in API docs (#287)

Browse source 
* Mention weights in API doc

Because this is reality :-)

* Mention balance property in API doc

Still because this is reality.
This commit is contained in:
JocelynDelalande 2017-12-21 13:56:25 +01:00 committed by Alexis Metaireau
parent 8a68ac0d5b
commit 0dfb9c5f94
1 changed files with 19 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
docs/api.rst
View file

@ -65,14 +65,20 @@ Getting information about the project::
"contact_email": "demo@notmyidea.org", "contact_email": "demo@notmyidea.org",
"password": "demo", "password": "demo",
"id": "demo", "id": "demo",
"active_members": [{"activated": true, "id": 31, "name": "Arnaud"}, "active_members": [{"activated": true, "weight": 1, "id": 31, "name": "Arnaud"},
{"activated": true, "id": 32, "name": "Alexis"}, {"activated": true, "weight": 1, "id": 32, "name": "Alexis"},
{"activated": true, "id": 33, "name": "Olivier"}, {"activated": true, "weight": 1, "id": 33, "name": "Olivier"},
{"activated": true, "id": 34, "name": "Fred"}], {"activated": true, "weight": 1, "id": 34, "name": "Fred"}],
"members": [{"activated": true, "id": 31, "name": "Arnaud"}, "members": [{"activated": true, "weight": 1, "id": 31, "name": "Arnaud"},
{"activated": true, "id": 32, "name": "Alexis"}, {"activated": true, "weight": 1, "id": 32, "name": "Alexis"},
{"activated": true, "id": 33, "name": "Olivier"}, {"activated": true, "weight": 1, "id": 33, "name": "Olivier"},
{"activated": true, "id": 34, "name": "Fred"}], {"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`:: 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\ $ curl --basic -u demo:demo https://ihatemoney.org/api/projects/demo/members\
[{"activated": true, "id": 31, "name": "Arnaud"}, [{"weight": 1, "activated": true, "id": 31, "name": "Arnaud"},
{"activated": true, "id": 32, "name": "Alexis"}, {"weight": 1, "activated": true, "id": 32, "name": "Alexis"},
{"activated": true, "id": 33, "name": "Olivier"}, {"weight": 1, "activated": true, "id": 33, "name": "Olivier"},
{"activated": true, "id": 34, "name": "Fred"}] {"weight": 1, "activated": true, "id": 34, "name": "Fred"}]
Add a member with a `POST` request on `/api/projects/<id>/members`:: 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\ $ curl --basic -u demo:demo -X PUT\
https://ihatemoney.org/api/projects/demo/members/36\ https://ihatemoney.org/api/projects/demo/members/36\
-d 'name=yeaaaaah' -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>`:: Delete a member with a `DELETE` request on `/api/projects/<id>/members/<member-id>`::