diff options
| author | Jocelyn Delalande <jocelyn@crapouillou.net> | 2016-08-18 18:06:37 +0200 |
|---|---|---|
| committer | Jocelyn Delalande <jocelyn@crapouillou.net> | 2016-08-18 18:06:37 +0200 |
| commit | 338f735d46f1f58a049e6c9c85e7aa0d47aece7a (patch) | |
| tree | 7aed4c3f0ffcd4d431b74faf3143cb74e1857140 /docs/api.rst | |
| parent | 74b087fe6a467c94649253515aba80be6b4a9c2a (diff) | |
| download | ihatemoney-mirror-338f735d46f1f58a049e6c9c85e7aa0d47aece7a.zip ihatemoney-mirror-338f735d46f1f58a049e6c9c85e7aa0d47aece7a.tar.gz ihatemoney-mirror-338f735d46f1f58a049e6c9c85e7aa0d47aece7a.tar.bz2 | |
Explain better multi-valued `payed_for` in API doc
… And use a multi-valued example, as it's IMHO the "standard" use-case with
IHM.
Diffstat (limited to 'docs/api.rst')
| -rw-r--r-- | docs/api.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/api.rst b/docs/api.rst index 56a4773..0f8d784 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -138,14 +138,14 @@ following params: * `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>`:: |