WEBDIENSTE/lasuite-docs
1
0
Fork 0
mirror of https://github.com/suitenumerique/docs.git synced 2026-09-12 12:47:55 +02:00
Code Issues Packages Projects Releases Wiki Activity

📝(backend) add breaking changes document in UPGRADE.md file

Browse Source 
We need to list the breaking changes made for the future version 5.0.0
This commit is contained in:
Manuel Raynaud
2026-04-27 15:07:31 +02:00
parent 6b3d19715b
commit 1c2bafb0f7
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
UPGRADE.md
+14
View File
@@ -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/<document_id>/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