diff options
author | Oliver Bertuch <o.bertuch@fz-juelich.de> | 2015-01-26 11:49:38 +0100 |
---|---|---|
committer | Oliver Bertuch <o.bertuch@fz-juelich.de> | 2015-01-26 11:49:38 +0100 |
commit | c0e5a469b61c3fef2560550ba9a820a9aac31857 (patch) | |
tree | 895c604535cdf2975aff37f39ddbb1e43b81d4b9 | |
parent | 62f5eeca68f8fc7ca530fe999700a9335cf1707b (diff) |
Fix JSON API Documentation for getAllTasks() parameters.
Documentation told us to use parameter "status", but it actually has to be "status_id".
This adds corrections to kanboard.py, too. It adds missing getTimezone() to kanboard.py, too.
-rw-r--r-- | docs/api-json-rpc.markdown | 4 | ||||
-rw-r--r-- | scripts/kanboard.py | 17 |
2 files changed, 17 insertions, 4 deletions
diff --git a/docs/api-json-rpc.markdown b/docs/api-json-rpc.markdown index 184739ad..4284df08 100644 --- a/docs/api-json-rpc.markdown +++ b/docs/api-json-rpc.markdown @@ -1052,7 +1052,7 @@ Response example: - Purpose: **Get all available tasks** - Parameters: - **project_id** (integer, required) - - **status**: The value 1 for active tasks and 0 for inactive (integer, required) + - **status_id**: The value 1 for active tasks and 0 for inactive (integer, required) - Result on success: **List of tasks** - Result on failure: **false** @@ -1065,7 +1065,7 @@ Request example to fetch all tasks on the board: "id": 133280317, "params": { "project_id": 1, - "status": 1 + "status_id": 1 } } ``` diff --git a/scripts/kanboard.py b/scripts/kanboard.py index 604448fa..65b51dc9 100644 --- a/scripts/kanboard.py +++ b/scripts/kanboard.py @@ -92,6 +92,19 @@ class Kanboard(): def _getId(self): self._id += 1 return self._id + + def getTimezone(self): + kid = self._getId() + params = { + "jsonrpc": "2.0", + "method": "getTimezone", + "id" : kid, + } + + response = requests.post(self.url, data=json.dumps(params), headers=self.headers, auth=(self.username, self.token)) + assert response.ok + assert response.json()['id'] == kid + return response.json()['result'] def createProject(self, name): kid = self._getId() @@ -546,7 +559,7 @@ class Kanboard(): return response.json()['result'] - def getAllTasks(self, project_id, status): + def getAllTasks(self, project_id, status_id): kid = self._getId() params = { "jsonrpc": "2.0", @@ -554,7 +567,7 @@ class Kanboard(): "id" : kid, "params": { "project_id": project_id, - "status": status + "status_id": status_id } } |