diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api-json-rpc.markdown | 115 | ||||
| -rw-r--r-- | docs/faq.markdown | 5 |
2 files changed, 120 insertions, 0 deletions
diff --git a/docs/api-json-rpc.markdown b/docs/api-json-rpc.markdown index 0440da0c..dcf92ea8 100644 --- a/docs/api-json-rpc.markdown +++ b/docs/api-json-rpc.markdown @@ -144,6 +144,32 @@ Array Procedures ---------- +### getVersion + +- Purpose: **Get the application version** +- Parameters: none +- Result: **version** (Example: 1.0.12, master) + +Request example: + +```json +{ + "jsonrpc": "2.0", + "method": "getVersion", + "id": 1661138292 +} +``` + +Response example: + +```json +{ + "jsonrpc": "2.0", + "id": 1661138292, + "result": "1.0.13" +} +``` + ### getTimezone - Purpose: **Get the application timezone** @@ -1019,6 +1045,95 @@ Response example: } ``` +### getAllSwimlanes + +- Purpose: **Get the list of all swimlanes of a project** +- Parameters: + - **project_id** (integer, required) +- Result on success: **swimlane properties** +- Result on failure: **null** + +Request example: + +```json +{ + "jsonrpc": "2.0", + "method": "getAllSwimlanes", + "id": 1242049935, + "params": [ + 2 + ] +} +``` + +Response example: + +```json +{ + "jsonrpc": "2.0", + "id": 1242049935, + "result": [ + { + "id": "0", + "name": "Default" + }, + { + "id": "3", + "name": "Version 1.0", + "is_active": "0", + "position": 1, + "project_id": 2 + }, + { + "id": "2", + "name": "Version 7.0", + "is_active": "1", + "position": 2, + "project_id": 2 + } + ] +} +``` + +### getSwimlane + +- Purpose: **Get the a swimlane** +- Parameters: + - **project_id** (integer, required) + - **name** (string, required) +- Result on success: **swimlane properties** +- Result on failure: **null** + +Request example: + +```json +{ + "jsonrpc": "2.0", + "method": "getSwimlane", + "id": 1242049935, + "params": [ + 2, + "Version 1.0" + ] +} +``` + +Response example: + +```json +{ + "jsonrpc": "2.0", + "id": 1242049935, + "result": { + "id": "3", + "name": "Version 1.0", + "is_active": "0", + "position": 2, + "project_id": 2 + } +} +``` + ### moveSwimlaneUp - Purpose: **Move up the swimlane position** diff --git a/docs/faq.markdown b/docs/faq.markdown index 0b7a3562..68bc686f 100644 --- a/docs/faq.markdown +++ b/docs/faq.markdown @@ -91,3 +91,8 @@ How to install Kanboard on Yunohost? [YunoHost](https://yunohost.org/) is a server operating system aiming to make self-hosting accessible to everyone. There is a [package to install Kanboard on Yunohost easily](https://github.com/mbugeia/kanboard_ynh). + + +Are there some tutorials about Kanboard in other languages? +------------------------------------ + - [German article series about Kanboard](http://demaya.de/wp/2014/07/kanboard-eine-jira-alternative-im-detail-installation/) |