diff options
| author | Alexis Metaireau <alexis@notmyidea.org> | 2016-09-12 16:19:48 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-09-12 16:19:48 +0200 |
| commit | bd07689de8f1502d82dd4f7d92ba3ee46582879c (patch) | |
| tree | 7aed4c3f0ffcd4d431b74faf3143cb74e1857140 | |
| parent | 6bcf5e3aa234b7796cc5b9ec652acd4c71a56724 (diff) | |
| parent | 338f735d46f1f58a049e6c9c85e7aa0d47aece7a (diff) | |
| download | ihatemoney-mirror-bd07689de8f1502d82dd4f7d92ba3ee46582879c.zip ihatemoney-mirror-bd07689de8f1502d82dd4f7d92ba3ee46582879c.tar.gz ihatemoney-mirror-bd07689de8f1502d82dd4f7d92ba3ee46582879c.tar.bz2 | |
Merge pull request #148 from JocelynDelalande/api-doc-precisions
REST API doc precisions
| -rw-r--r-- | docs/api.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/api.rst b/docs/api.rst index ce5df71..0f8d784 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -135,17 +135,17 @@ You can get the list of bills by doing a `GET` on `/api/projects/<id>/bills` :: Add a bill with a `POST` query on `/api/projects/<id>/bills`. you need the following params: -* `date`: the date of the bill. (yy-mm-dd) +* `date`: the date of the bill; defaults to current date if not provided. (yy-mm-dd) * `what`: what have been payed * `payer`: by who ? (id) -* `payed_for`: list of ids +* `payed_for`: for who ? (id, repeat the parameter to set multiple id) * `amount`: amount payed Returns the id of the created bill :: $ curl --basic -u demo:demo -X POST\ http://ihatemoney.notmyidea.org/api/projects/demo/bills\ - -d "date=2011-09-10&what=raclette&payer=31&payed_for=31&amount=200" + -d "date=2011-09-10&what=raclette&payer=31&payed_for=31&payed_for=35&amount=200" 80 You can also `PUT` a new version of the bill at @@ -153,7 +153,7 @@ You can also `PUT` a new version of the bill at $ curl --basic -u demo:demo -X PUT\ http://ihatemoney.notmyidea.org/api/projects/demo/bills/80\ - -d "date=2011-09-10&what=raclette&payer=31&payed_for=31&amount=250" + -d "date=2011-09-10&what=raclette&payer=31&payed_for=31&payed_for=35&amount=250" 80 And you can of course `DELETE` them at `/api/projects/<id>/bills/<bill-id>`:: |