From 73020ec0d31c70350ef13067a60f8d2b0554d03a Mon Sep 17 00:00:00 2001 From: Damyan Ivanov Date: Wed, 16 Feb 2022 20:31:51 +0000 Subject: [PATCH] document list and item URIs containing unique IDs in them --- doc/protocol.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/protocol.md b/doc/protocol.md index e0cf516..d70f595 100644 --- a/doc/protocol.md +++ b/doc/protocol.md @@ -15,7 +15,9 @@ GET /list Returns a JSON object with the following keys: - `lists`: a list of objects with the following keys: - - `uri`: tjhe list URIs. Referred to as `/list/$list_id` below. + - `uri`: the list URI. Referred to as `/list/$list_id` below. The part after + the last `/` (`$list_id`) is an integer that is unique among all shopping + lists - `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 @@ -27,7 +29,9 @@ GET /list/$list_id Returns a JSON object with the following keys: - `items`: a list of shopping list item objects with keys: - - `uri`: the URI of the individual list item + - `uri`: the URI of the individual list item (refered to as + `/list/$list_id/$item_id` below. The part after the last `/` (`$list_id`) + is a positive integer that is unique amont the items in the shopping list. - `description`: item description - `done`: a boolean flag marking the item as done - `version`: a number that is incremented by 1 each time the list items -- 2.39.2