marcel/linkding
1
0
Fork 0
mirror of https://github.com/sissbruecker/linkding.git synced 2025-08-08 19:28:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

Do not clear fields in POST requests (API behavior change) (#852)

Browse Source
This commit is contained in:
Sascha Ißbrücker
2024-09-24 11:37:50 +02:00
committed by GitHub
parent 23ad52f75d
commit 7b405c054d
5 changed files with 113 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/src/content/docs/api.md
View File

@@ -155,34 +155,13 @@ Example payload:
```
PUT /api/bookmarks/<id>/
```
Updates a bookmark.
This is a full update, which requires at least a URL, and fields that are not specified are cleared or reset to their defaults.
Tags are simply assigned using their names.
Example payload:
```json
{
"url": "https://example.com",
"title": "Example title",
"description": "Example description",
"tag_names": [
"tag1",
"tag2"
]
}
```
**Patch**
```
PATCH /api/bookmarks/<id>/
```
Updates a bookmark partially.
Allows to modify individual fields of a bookmark.
Updates a bookmark.
When using `POST`, at least all required fields must be provided (currently only `url`).
When using `PATCH`, only the fields that should be updated need to be provided.
Regardless which method is used, any field that is not provided is not modified.
Tags are simply assigned using their names.
Example payload: