eliott/docs
1
0
Fork 0
mirror of https://github.com/suitenumerique/docs.git synced 2026-04-25 17:15:01 +02:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Manuel Raynaud
2026-04-22 10:51:55 +02:00
parent a577264940
commit 8d3fbb9b2d
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
UPGRADE.md
View File

@@ -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",