From ced39c950129636526442a04415eb70bace00b5b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julius=20H=C3=A4rtl?= Date: Tue, 11 Jan 2022 08:56:34 +0100 Subject: [PATCH] Extend API changelog MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Julius Härtl --- docs/API.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/docs/API.md b/docs/API.md index d3191b96a..e81553e3b 100644 --- a/docs/API.md +++ b/docs/API.md @@ -96,10 +96,27 @@ If available the ETag will also be part of JSON response objects as shown below # Changelog -## 1.0.0 (unreleased) +## API version 1.0 + +- Deck >=1.0.0: The maximum length of the card title has been extended from 100 to 255 characters +- Deck >=1.0.0: The API will now return a 400 Bad request response if the length limitation of a board, stack or card title is exceeded + +## API version 1.1 + +This API version has become available with **Deck 1.3.0**. - The maximum length of the card title has been extended from 100 to 255 characters - The API will now return a 400 Bad request response if the length limitation of a board, stack or card title is exceeded +- The attachments API endpoints will return other attachment types than deck_file + - Prior to Deck version v1.3.0 (API v1.0), attachments were stored within deck. For this type of attachments `deck_file` was used as the default type of attachments + - Starting with Deck version 1.3.0 (API v1.1) files are stored within the users regular Nextcloud files and the type `file` has been introduced for that + +## API version 1.2 (unreleased) + +- Endpoints for the new import functionality have been added: + - [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) + - [POST /boards/import - Import a board](#post-boardsimport-import-a-board) # Endpoints @@ -927,7 +944,8 @@ The request can fail with a bad request response for the following reasons: | type | String | The type of the attachement | | file | Binary | File data to add as an attachment | -For now only `deck_file` is supported as an attachment type. +- Prior to Deck version v1.3.0 (API v1.0), attachments were stored within deck. For this type of attachments `deck_file` was used as the default type of attachments +- Starting with Deck version 1.3.0 (API v1.1) files are stored within the users regular Nextcloud files and the type `file` has been introduced for that #### Response