diff options
| author | Francois Ferrand <thetypz@gmail.com> | 2015-02-24 14:20:34 +0100 |
|---|---|---|
| committer | Francois Ferrand <thetypz@gmail.com> | 2015-02-24 14:21:23 +0100 |
| commit | dedf425e8168b2c38e8566a3d407f77fb11cc001 (patch) | |
| tree | 1ea3e6bbb6bce46c34ade9cb9ee216fc7a63a718 /docs/api-json-rpc.markdown | |
| parent | 0450d86a18b1bc16b88bf3d3540a00eb9318203e (diff) | |
Add project description field.
Description is shown in a popup when hovering the 'information' icon, like column description,
which is shown in project list on dashboard and in board's title.
This is useful to document the categories and colors used in the project.
Diffstat (limited to 'docs/api-json-rpc.markdown')
| -rw-r--r-- | docs/api-json-rpc.markdown | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/docs/api-json-rpc.markdown b/docs/api-json-rpc.markdown index 346b1dec..0e646437 100644 --- a/docs/api-json-rpc.markdown +++ b/docs/api-json-rpc.markdown @@ -176,6 +176,7 @@ Response example: - Purpose: **Create a new project** - Parameters: - **name** (string, required) + - **description** (string, optional) - Result on success: **project_id** - Result on failure: **false** @@ -235,7 +236,8 @@ Response example: "is_active": "1", "token": "", "last_modified": "1410263246", - "is_public": "0" + "is_public": "0", + "description": "A sample project" } } ``` @@ -273,7 +275,8 @@ Response example: "is_active": "1", "token": "", "last_modified": "0", - "is_public": "0" + "is_public": "0", + "description": "A sample project" } } ``` @@ -309,7 +312,8 @@ Response example: "is_active": "1", "token": "", "last_modified": "0", - "is_public": "0" + "is_public": "0", + "description": "PHP client project" }, { "id": "1", @@ -317,7 +321,8 @@ Response example: "is_active": "1", "token": "", "last_modified": "0", - "is_public": "0" + "is_public": "0", + "description": "Test project" } ] } @@ -332,6 +337,7 @@ Response example: - **is_active** (integer, optional) - **token** (string, optional) - **is_public** (integer, optional) + - **description** (string, optional) - Result on success: **true** - Result on failure: **false** |