ahtlon/deck
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Add length documentation for title attributes in the API documentation

Browse Source 
Signed-off-by: Julius Härtl <jus@bitgrid.net>
This commit is contained in:
Julius Härtl
2020-04-20 11:00:09 +02:00
parent a445ed672b
commit 9cc28b7fd1
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/API.md
View File

@@ -117,7 +117,7 @@ Returns an array of board items
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ------ | ---------------------------------------------------- | | --------- | ------ | ---------------------------------------------------- |
| title | String | The title of the new board | | title | String | The title of the new board, maximum length is limited to 100 characters |
| color | String | The hexadecimal color of the new board (e.g. FF0000) | | color | String | The hexadecimal color of the new board (e.g. FF0000) |
```json ```json
@@ -261,9 +261,9 @@ Returns an array of board items
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ------ | ---------------------------------------------------- | | --------- | ------ | ---------------------------------------------------- |
| title | String | The title of the new board | | title | String | The title of the board, maximum length is limited to 100 characters |
| color | String | The hexadecimal color of the new board (e.g. FF0000) | | color | String | The hexadecimal color of the board (e.g. FF0000) |
| archived | Bool | The hexadecimal color of the new board (e.g. FF0000) | | archived | Bool | The hexadecimal color of the board (e.g. FF0000) |
```json ```json
{ {
@@ -437,7 +437,7 @@ The board list endpoint supports setting an `If-Modified-Since` header to limit
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ------- | ---------------------------------------------------- | | --------- | ------- | ---------------------------------------------------- |
| title | String | The title of the new stack | | title | String | The title of the new stack, maximum length is limited to 100 characters |
| order | Integer | Order for sorting the stacks | | order | Integer | Order for sorting the stacks |
#### Request parameters #### Request parameters
@@ -463,7 +463,7 @@ The board list endpoint supports setting an `If-Modified-Since` header to limit
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ------- | ---------------------------------------------------- | | --------- | ------- | ---------------------------------------------------- |
| title | String | The title of the new stack | | title | String | The title of the stack, maximum length is limited to 100 characters |
| order | Integer | Order for sorting the stacks | | order | Integer | Order for sorting the stacks |
#### Response #### Response
@@ -512,7 +512,7 @@ The board list endpoint supports setting an `If-Modified-Since` header to limit
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ------- | ---------------------------------------------------- | | --------- | ------- | ---------------------------------------------------- |
| title | String | The title of the new stack | | title | String | The title of the card, maximum length is limited to 255 characters |
| type | String | Type of the card (for later use) use 'plain' for now | | type | String | Type of the card (for later use) use 'plain' for now |
| order | Integer | Order for sorting the stacks | | order | Integer | Order for sorting the stacks |
| description | String | _(optional)_ The markdown description of the card | | description | String | _(optional)_ The markdown description of the card |
@@ -559,7 +559,7 @@ The board list endpoint supports setting an `If-Modified-Since` header to limit
| Parameter | Type | Description | | Parameter | Type | Description |
|-------------|-----------|------------------------------------------------------| |-------------|-----------|------------------------------------------------------|
| title | String | The card title | | title | String | The title of the card, maximum length is limited to 255 characters |
| description | String | The markdown description of the card | | description | String | The markdown description of the card |
| type | String | Type of the card (for later use) use 'plain' for now | | type | String | Type of the card (for later use) use 'plain' for now |
| order | Integer | Order for sorting the stacks | | order | Integer | Order for sorting the stacks |