From 1c2bafb0f7a76a9c43f5f3713b0f1e5cdec5fe54 Mon Sep 17 00:00:00 2001 From: Manuel Raynaud Date: Tue, 7 Apr 2026 17:29:23 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D(backend)=20add=20breaking=20change?= =?UTF-8?q?s=20document=20in=20UPGRADE.md=20file?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit We need to list the breaking changes made for the future version 5.0.0 --- UPGRADE.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/UPGRADE.md b/UPGRADE.md index caf566b48..96d140f1a 100644 --- a/UPGRADE.md +++ b/UPGRADE.md @@ -16,6 +16,20 @@ the following command inside your docker container: ## [Unreleased] +We made several changes around document content management leading to several breaking changes in the API. + +- The endpoint `/api/v1.0/documents/{document_id}/content/` has been renamed in `/api/v1.0/documents/{document_id}/formatted-content/` +- There is no more `content` attribute in the response of `/api/v1.0/documents/{document_id}/`, two new endpoints have been added to retrieve or update the document content. +- A new `GET /api/v1.0/documents/{document_id}/content/` endpoint has been implemented to fetch the document content ; this endpoint streams the whole content with a `text/plain` content-type response. +- A new `PATCH /api/v1.0/documents/{document_id}/content/` endpoint has been added to update the document content ; expected payload is: +```json +{ + "content": "document content in base64", +} +``` + +Other changes: + - The deprecated endpoint `/api/v1.0/documents//descendants` is removed. The search endpoint should be used instead. - Upgrade docspec dependency to version >= 3.0.0 The docspec service has changed since version 3.0.0, we ware now compatible with this version and not with version 2.x.x anymore