Permalink
Browse files

Documented REST interface.

  • Loading branch information...
1 parent 3310d1b commit 3b7f92bc1d6aac73d185b4265f1ae972e7129ab0 @mcantelon committed Feb 8, 2012
Showing with 35 additions and 1 deletion.
  1. +35 −1 README.md
View
@@ -118,7 +118,41 @@ configure your Elflord client to connect to it.
## REST API
-Yeah, I should probably document this soon.
+### List all tasks
+
+Method: GET
+Params: password
+Path: /tasks
+
+### List categories
+
+Method: GET
+Params: password
+Path: /categories
+
+### List tasks in category
+
+Method: GET
+Params: password
+Path: /categories/<category>
+
+### Add task
+
+Method: POST
+Params: password, description, category (optional), priority (optional)
+Path: /tasks
+
+### Update task
+
+Method: PUT
+Params: password, description (optional), category (optional), priority (optional)
+Path: /tasks/<task ID>
+
+### Delete task
+
+Method: DELETE
+Params: password
+Path: /tasks/<task ID>
## Underpinnings

0 comments on commit 3b7f92b

Please sign in to comment.