AS1024
/
Kanboard-Prod
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix cosmetic issues and update api documentation

This commit is contained in:
Frederic Guillot 2016-02-20 15:31:26 -05:00
parent fc468088c3
commit 0261c751cf
11 changed files with 246 additions and 273 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ChangeLog
View File

@ -1,6 +1,10 @@
Version 1.0.26 (unreleased)
--------------
Breaking changes:
* API procedures: "moveColumnUp" and "moveColumnDown" are replace by "changeColumnPosition"
New features:
* Add drag and drop to change subtasks and columns positions

1
app/Api/File.php
View File

@ -2,7 +2,6 @@
namespace Kanboard\Api;
use Kanboard\Core\Base;
use Kanboard\Core\ObjectStorage\ObjectStorageException;
/**

12
app/Api/Task.php
View File

@ -75,9 +75,9 @@ class Task extends Base
}
public function createTask($title, $project_id, $color_id = '', $column_id = 0, $owner_id = 0, $creator_id = 0,
$date_due = '', $description = '', $category_id = 0, $score = 0, $swimlane_id = 0,
$recurrence_status = 0, $recurrence_trigger = 0, $recurrence_factor = 0, $recurrence_timeframe = 0,
$recurrence_basedate = 0, $reference = '')
$date_due = '', $description = '', $category_id = 0, $score = 0, $swimlane_id = 0,
$recurrence_status = 0, $recurrence_trigger = 0, $recurrence_factor = 0, $recurrence_timeframe = 0,
$recurrence_basedate = 0, $reference = '')
{
$this->checkProjectPermission($project_id);
@ -115,9 +115,9 @@ class Task extends Base
}
public function updateTask($id, $title = null, $color_id = null, $owner_id = null,
$date_due = null, $description = null, $category_id = null, $score = null,
$recurrence_status = null, $recurrence_trigger = null, $recurrence_factor = null,
$recurrence_timeframe = null, $recurrence_basedate = null, $reference = null)
$date_due = null, $description = null, $category_id = null, $score = null,
$recurrence_status = null, $recurrence_trigger = null, $recurrence_factor = null,
$recurrence_timeframe = null, $recurrence_basedate = null, $reference = null)
{
$this->checkTaskPermission($id);

3
app/Controller/Auth.php
View File

@ -58,8 +58,7 @@ class Auth extends Base
if (! DISABLE_LOGOUT) {
$this->sessionManager->close();
$this->response->redirect($this->helper->url->to('auth', 'login'));
}
else {
} else {
$this->response->redirect($this->helper->url->to('auth', 'index'));
}
}

1
app/Core/Base.php
View File

@ -63,6 +63,7 @@ use Pimple\Container;
* @property \Kanboard\Model\Board $board
* @property \Kanboard\Model\Category $category
* @property \Kanboard\Model\Color $color
* @property \Kanboard\Model\Column $column
* @property \Kanboard\Model\Comment $comment
* @property \Kanboard\Model\Config $config
* @property \Kanboard\Model\Currency $currency

2
app/Model/Board.php
View File

@ -2,8 +2,6 @@
namespace Kanboard\Model;
use PicoDb\Database;
/**
* Board model
*

6
app/Model/LastLogin.php
View File

@ -65,9 +65,9 @@ class LastLogin extends Base
if (count($connections) >= self::NB_LOGINS) {
$this->db->table(self::TABLE)
->eq('user_id', $user_id)
->notin('id', array_slice($connections, 0, self::NB_LOGINS - 1))
->remove();
->eq('user_id', $user_id)
->notin('id', array_slice($connections, 0, self::NB_LOGINS - 1))
->remove();
}
}

2
app/Model/User.php
View File

@ -137,7 +137,7 @@ class User extends Base
*
* @access public
* @param string $username Username
* @return array
* @return integer
*/
public function getIdByUsername($username)
{

258
doc/api-board-procedures.markdown
View File

@ -156,261 +156,3 @@ Response example:
]
}
```
## 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"
}
}
```
## moveColumnUp
- Purpose: **Move up the column position**
- Parameters:
- **project_id** (integer, required)
- **column_id** (integer, required)
- Result on success: **true**
- Result on failure: **false**
Request example:
```json
{
"jsonrpc": "2.0",
"method": "moveColumnUp",
"id": 99275573,
"params": [
1,
2
]
}
```
Response example:
```json
{
"jsonrpc": "2.0",
"id": 99275573,
"result": true
}
```
## moveColumnDown
- Purpose: **Move down the column position**
- Parameters:
- **project_id** (integer, required)
- **column_id** (integer, required)
- Result on success: **true**
- Result on failure: **false**
Request example:
```json
{
"jsonrpc": "2.0",
"method": "moveColumnDown",
"id": 957090649,
"params": {
"project_id": 1,
"column_id": 2
}
}
```
Response example:
```json
{
"jsonrpc": "2.0",
"id": 957090649,
"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
}
```

229
doc/api-column-procedures.markdown Normal file
View File

@ -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)
- 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
}
```

1
doc/api-json-rpc.markdown
View File

@ -52,6 +52,7 @@ Usage
- [Projects](api-project-procedures.markdown)
- [Project Permissions](api-project-permission-procedures.markdown)
- [Boards](api-board-procedures.markdown)
- [Columns](api-column-procedures.markdown)
- [Swimlanes](api-swimlane-procedures.markdown)
- [Categories](api-category-procedures.markdown)
- [Automatic Actions](api-action-procedures.markdown)