Elgato_dark/docs
1
0
Fork 0
mirror of https://github.com/suitenumerique/docs synced 2026-04-21 13:37:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

📝(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-07 17:29:23 +02:00 committed by Anthony LC
parent d5a4468f96
commit 4b8aa897fb
No known key found for this signature in database
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
UPGRADE.md
View file

@ -16,6 +16,18 @@ 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 renammed 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:
```json
{
"content": "document content in base64",
}
```
## [4.6.0] - 2026-02-27
- ⚠️ Some setup have changed to offer a bigger flexibility and consistency, overriding the favicon and logo are now from the theme configuration.