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

docs: Update API docs

Browse Source 
Signed-off-by: Julius Härtl <jus@bitgrid.net>
This commit is contained in:
Julius Härtl
2023-11-08 12:52:14 +01:00
parent 6d671338b6
commit 71cb08b00f
1 changed files with 25 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/API.md
View File

@@ -117,6 +117,7 @@ This API version has become available with **Deck 1.3.0**.
- [GET /boards/import/getSystems - Import a board](#get-boardsimportgetsystems-import-a-board) - [GET /boards/import/getSystems - Import a board](#get-boardsimportgetsystems-import-a-board)
- [GET /boards/import/config/system/{schema} - Import a board](#get-boardsimportconfigsystemschema-import-a-board) - [GET /boards/import/config/system/{schema} - Import a board](#get-boardsimportconfigsystemschema-import-a-board)
- [POST /boards/import - Import a board](#post-boardsimport-import-a-board) - [POST /boards/import - Import a board](#post-boardsimport-import-a-board)
- The `done` property was added to cards
# Endpoints # Endpoints
@@ -601,7 +602,7 @@ The board list endpoint supports setting an `If-Modified-Since` header to limit
"owner":"admin", "owner":"admin",
"order":999, "order":999,
"archived":false, "archived":false,
"done":false, "done":null,
"duedate": "2019-12-24T19:29:30+00:00", "duedate": "2019-12-24T19:29:30+00:00",
"deletedAt":0, "deletedAt":0,
"commentsUnread":0, "commentsUnread":0,
@@ -624,16 +625,16 @@ The board list endpoint supports setting an `If-Modified-Since` header to limit
#### Request data #### Request data
| Parameter | Type | Description | | Parameter | Type | Description |
|-------------|-----------|------------------------------------------------------| |-------------|-----------------|-----------------------------------------------------------------------------------------------------|
| title | String | The title of the card, maximum length is limited to 255 characters | | 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 |
| owner | String | The user that owns the card | | owner | String | The user that owns the card |
| order | Integer | Order for sorting the stacks | | order | Integer | Order for sorting the stacks |
| duedate | timestamp | The ISO-8601 formatted duedate of the card or null | | duedate | timestamp | The ISO-8601 formatted duedate of the card or null |
| archived | bool | Whether the card is archived or not | | archived | bool | Whether the card is archived or not |
| done | bool | Whether the card is marked as done or not | | done | timestamp\|null | The ISO-8601 formatted date when the card is marked as done (optional, null indicates undone state) |
``` ```
@@ -645,7 +646,7 @@ The board list endpoint supports setting an `If-Modified-Since` header to limit
"order": 999, "order": 999,
"duedate": "2019-12-24T19:29:30+00:00", "duedate": "2019-12-24T19:29:30+00:00",
"archived": false, "archived": false,
"done": false, "done": null,
} }
``` ```