From 15e1ed6148632b7008875207f26345f472a909d1 Mon Sep 17 00:00:00 2001
From: Frédéric Guillot <fred@kanboard.net>
Date: Fri, 12 Sep 2014 15:14:59 +0200
Subject: Improve API calls for subtasks

---
 docs/api-json-rpc.markdown | 157 +++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 152 insertions(+), 5 deletions(-)

(limited to 'docs')

diff --git a/docs/api-json-rpc.markdown b/docs/api-json-rpc.markdown
index 3e35290b..fa9fec85 100644
--- a/docs/api-json-rpc.markdown
+++ b/docs/api-json-rpc.markdown
@@ -1098,34 +1098,181 @@ Response example:
 ### createSubtask
 
 - Purpose: **Create a new subtask**
-- Parameters: Key/value pair composed of the **title** (integer), time_estimated (int, optional), task_id (int), user_id (int, optional)
+- Parameters:
+    - **task_id** (integer, required)
+    - **title** (integer, required)
+    - **assignee_id** (int, optional)
+    - **time_estimated** (int, optional)
+    - **time_spent** (int, optional)
+    - **status** (int, optional)
 - Result on success: **true**
 - Result on failure: **false**
 
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "createSubtask",
+    "id": 2041554661,
+    "params": {
+        "task_id": 1,
+        "title": "Subtask #1"
+    }
+}
+```
+
+Response example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 2041554661,
+    "result": true
+}
+```
+
 ### getSubtask
 
 - Purpose: **Get subtask information**
-- Parameters: **subtask_id** (integer)
+- Parameters:
+    - **subtask_id** (integer)
 - Result on success: **subtask properties**
 - Result on failure: **null**
 
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "getSubtask",
+    "id": 133184525,
+    "params": {
+        "subtask_id": 1
+    }
+}
+```
+
+Response example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 133184525,
+    "result": {
+        "id": "1",
+        "title": "Subtask #1",
+        "status": "0",
+        "time_estimated": "0",
+        "time_spent": "0",
+        "task_id": "1",
+        "user_id": "0"
+    }
+}
+```
+
 ### getAllSubtasks
 
 - Purpose: **Get all available subtasks**
-- Parameters: **none**
+- Parameters:
+    - **task_id** (integer, required)
 - Result on success: **List of subtasks**
 - Result on failure: **false**
 
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "getAllSubtasks",
+    "id": 2087700490,
+    "params": {
+        "task_id": 1
+    }
+```
+
+Response example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 2087700490,
+    "result": [
+        {
+            "id": "1",
+            "title": "Subtask #1",
+            "status": "0",
+            "time_estimated": "0",
+            "time_spent": "0",
+            "task_id": "1",
+            "user_id": "0",
+            "username": null,
+            "name": null,
+            "status_name": "Todo"
+        },
+        ...
+    ]
+}
+```
+
 ### updateSubtask
 
 - Purpose: **Update a subtask**
-- Parameters: Key/value pair composed of the **id** (integer), **title** (integer), status (integer, optional) time_estimated (int, optional), time_spent (int, optional), task_id (int), user_id (int, optional)
+- Parameters:
+    - **id** (integer, required)
+    - **task_id** (integer, required)
+    - **title** (integer, optional)
+    - **assignee_id** (integer, optional)
+    - **time_estimated (integer, optional)
+    - **time_spent** (integer, optional)
+    - **status** (integer, optional)
 - Result on success: **true**
 - Result on failure: **false**
 
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "updateSubtask",
+    "id": 191749979,
+    "params": {
+        "id": 1,
+        "task_id": 1,
+        "status": 1,
+        "time_spent": 5,
+        "user_id": 1
+    }
+}
+```
+
+Response example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 191749979,
+    "result": true
+}
+```
+
 ### removeSubtask
 
 - Purpose: **Remove a subtask**
-- Parameters: **subtask_id** (integer)
+- Parameters:
+    **subtask_id** (integer, required)
 - Result on success: **true**
 - Result on failure: **false**
+
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "removeSubtask",
+    "id": 1382487306,
+    "params": {
+        "subtask_id": 1
+    }
+}
+```
+
+Response example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 1382487306,
+    "result": true
+}
+```
-- 
cgit v1.2.3