typo in doc

[lsl.git] / doc / protocol.md

diff --git a/doc/protocol.md b/doc/protocol.md
index e0cf516c6658b533acb312c1ec5aa69153fc7e58..25ab284d2067f48cc2937603799867ce70b67c6e 100644 (file)
--- 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
@@ -68,7 +72,7 @@ Modifies a list. Request body is a JSON object with the following keys:
 
 Successful (HTTP status 200) response is a JSON object with the following keys:
 
- - `version`: the curre version of the list
+ - `version`: the current version of the list
  - `lists_version`: the new version of the list of lists
 
 Possible error responses: