Merge pull request #1 from fguillot/master

Update from upstream

1 files changed, 229 insertions, 0 deletions

diff --git a/doc/api-column-procedures.markdown b/doc/api-column-procedures.markdown
new file mode 100644
index 00000000..c5d2793b
--- /dev/null
+++ b/doc/api-column-procedures.markdown
@@ -0,0 +1,229 @@
+API Column Procedures
+=====================
+
+## getColumns
+
+- Purpose: **Get all columns information for a given project**
+- Parameters:
+    - **project_id** (integer, required)
+- Result on success: **columns properties**
+- Result on failure: **empty list**
+
+Request example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "getColumns",
+    "id": 887036325,
+    "params": [
+        1
+    ]
+}
+```
+
+Response example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 887036325,
+    "result": [
+        {
+            "id": "1",
+            "title": "Backlog",
+            "position": "1",
+            "project_id": "1",
+            "task_limit": "0"
+        },
+        {
+            "id": "2",
+            "title": "Ready",
+            "position": "2",
+            "project_id": "1",
+            "task_limit": "0"
+        },
+        {
+            "id": "3",
+            "title": "Work in progress",
+            "position": "3",
+            "project_id": "1",
+            "task_limit": "0"
+        }
+    ]
+}
+```
+
+## getColumn
+
+- Purpose: **Get a single column**
+- Parameters:
+    - **column_id** (integer, required)
+- Result on success: **column properties**
+- Result on failure: **null**
+
+Request example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "getColumn",
+    "id": 1242049935,
+    "params": [
+        2
+    ]
+}
+```
+
+Response example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 1242049935,
+    "result": {
+        "id": "2",
+        "title": "Youpi",
+        "position": "2",
+        "project_id": "1",
+        "task_limit": "5"
+    }
+}
+```
+
+## changeColumnPosition
+
+- Purpose: **Change the column position**
+- Parameters:
+    - **project_id** (integer, required)
+    - **column_id** (integer, required)
+    - **position** (integer, required, must be >= 1)
+- Result on success: **true**
+- Result on failure: **false**
+
+Request example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "changeColumnPosition",
+    "id": 99275573,
+    "params": [
+        1,
+        2,
+        3
+    ]
+}
+```
+
+Response example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 99275573,
+    "result": true
+}
+```
+
+## updateColumn
+
+- Purpose: **Update column properties**
+- Parameters:
+    - **column_id** (integer, required)
+    - **title** (string, required)
+    - **task_limit** (integer, optional)
+    - **description** (string, optional)
+- Result on success: **true**
+- Result on failure: **false**
+
+Request example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "updateColumn",
+    "id": 480740641,
+    "params": [
+        2,
+        "Boo",
+        5
+    ]
+}
+```
+
+Response example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 480740641,
+    "result": true
+}
+```
+
+## addColumn
+
+- Purpose: **Add a new column**
+- Parameters:
+    - **project_id** (integer, required)
+    - **title** (string, required)
+    - **task_limit** (integer, optional)
+    - **description** (string, optional)
+- Result on success: **column_id**
+- Result on failure: **false**
+
+Request example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "addColumn",
+    "id": 638544704,
+    "params": [
+        1,
+        "Boo"
+    ]
+}
+```
+
+Response example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 638544704,
+    "result": 5
+}
+```
+
+## removeColumn
+
+- Purpose: **Remove a column**
+- Parameters:
+    - **column_id** (integer, required)
+- Result on success: **true**
+- Result on failure: **false**
+
+Request example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "removeColumn",
+    "id": 1433237746,
+    "params": [
+        1
+    ]
+}
+```
+
+Response example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 1433237746,
+    "result": true
+}
+```