From 8d3fbb9b2dc72c58af034d197ffb7b79add709e3 Mon Sep 17 00:00:00 2001 From: Manuel Raynaud Date: Wed, 22 Apr 2026 10:51:55 +0200 Subject: [PATCH] =?UTF-8?q?fixup!=20=F0=9F=93=9D(backend)=20add=20breaking?= =?UTF-8?q?=20changes=20document=20in=20UPGRADE.md=20file?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- UPGRADE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/UPGRADE.md b/UPGRADE.md index b6e0f4900..561ea519a 100644 --- a/UPGRADE.md +++ b/UPGRADE.md @@ -18,10 +18,10 @@ the following command inside your docker container: 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 renammed in `/api/v1.0/documents/{document_id}/formatted-content/` +- 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. -- New endpoint `GET /api/v1.0/documents/{document_id}/content/` to fetch the document content, this endpoint directly return the content and the response content-type is `text/plain` -- New endpoint `PATCH /api/v1.0/documents/{document_id}/content/` to update the document content. the expected payload is: +- 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",