X-Git-Url: https://git.ktnx.net/?a=blobdiff_plain;f=doc%2Fprotocol.md;fp=doc%2Fprotocol.md;h=e0cf516c6658b533acb312c1ec5aa69153fc7e58;hb=020687a66b8b6e53c68e50d14719f1cdf02e2975;hp=ae7bad53862528ed15f5a9343393953ee9c0c692;hpb=0ddba2456ee68202f1086a8f5db82ac5e2403b6c;p=lsl.git diff --git a/doc/protocol.md b/doc/protocol.md index ae7bad5..e0cf516 100644 --- a/doc/protocol.md +++ b/doc/protocol.md @@ -14,8 +14,9 @@ GET /list Returns a JSON object with the following keys: - - `lists`: a list of shopping list URIs. Referred to as `/list/$list_id` - below. + - `lists`: a list of objects with the following keys: + - `uri`: tjhe list URIs. Referred to as `/list/$list_id` below. + - `name`: list name as entered by users - `lists_version`: a number that is incremented by 1 each time the list of shopping lists changes. Changes include adding, removing and renaming a shopping list, but not changes to individual shopping list items. @@ -25,7 +26,6 @@ GET /list/$list_id Returns a JSON object with the following keys: - - `name`: list name, as entered by users - `items`: a list of shopping list item objects with keys: - `uri`: the URI of the individual list item - `description`: item description