nextcloud
/
bookmarks
mirror of https://github.com/nextcloud/bookmarks
0
0
Fork 0
Code Issues Releases Wiki Activity

Update documentation of API responses 

Signed-off-by: Kai <git@altepizza.de>
This commit is contained in:
Kai 2020-07-03 23:12:14 +02:00 committed by Marcel Klehr
parent 2f70eece2e
commit 1b998344c8
2 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/bookmark.rst
View File

@ -56,7 +56,7 @@ Query bookmarks
{
"status": "success",
"data": [{ "id": "7", "title": "Google", "tags": ["firsttag"] }]
"data": [{ "id": 7, "title": "Google", "tags": ["firsttag"] }]
}
Create a bookmark
@ -102,12 +102,12 @@ Create a bookmark
{
"status": "success",
"item": {
"id": "7",
"id": 7,
"url": "http://google.com",
"title": "Google",
"description":"in case i forget",
"tags": ["search-engines", "uselessbookmark"],
"folders": ["-1"]
"folders": [-1]
}
}
@ -142,12 +142,12 @@ Get a bookmark
{
"status": "success",
"item": {
"id": "7",
"id": 7,
"url": "http://google.com",
"title": "Google",
"description":"in case i forget",
"tags": ["search-engines", "uselessbookmark"],
"folders": ["-1"]
"folders": [-1]
}
}
@ -190,12 +190,12 @@ Edit a bookmark
{
"status": "success",
"item": {
"id": "7",
"id": 7,
"url": "http://google.com",
"title": "Boogle",
"description":"in case i forget",
"tags": ["search-engines", "uselessbookmark"],
"folders": ["-1"]
"folders": [-1]
}
}

30
docs/folder.rst
View File

@ -55,10 +55,10 @@ Get full hierarchy
{
"status": "success", "data": [
{"id": "1", "title": "work", "parent_folder": "-1"},
{"id": "2", "title": "personal", "parent_folder": "-1", "children": [
{"id": "3", "title": "garden", "parent_folder": "2"},
{"id": "4", "title": "music", "parent_folder": "2"}
{"id": 1, "title": "work", "parent_folder": -1},
{"id": 2, "title": "personal", "parent_folder": -1, "children": [
{"id": 3, "title": "garden", "parent_folder": 2},
{"id": 4, "title": "music", "parent_folder": 2}
]},
]
}
@ -93,9 +93,9 @@ Get single folder
{
"status": "success",
"item": {
"id": "2",
"id": 2,
"title": "My Personal Bookmarks",
"parent_folder": "-1"
"parent_folder": -1
}
}
@ -178,7 +178,7 @@ Edit a folder
"item": {
"id": 5,
"title": "optional physical activity",
"parent_folder": "-1"
"parent_folder": -1
}
}
@ -375,10 +375,10 @@ Get folder's content order
{
"status": "success",
"data": [
{"type": "folder", "id": "17"},
{"type": "bookmark", "id": "204"},
{"type": "bookmark", "id": "192"},
{"type": "bookmark", "id": "210"}
{"type": "folder", "id": 17},
{"type": "bookmark", "id": 204},
{"type": "bookmark", "id": 192},
{"type": "bookmark", "id": 210}
]
}
@ -409,10 +409,10 @@ Set folder's content order
{
"status": "success",
"data": [
{"type": "folder", "id": "17"},
{"type": "bookmark", "id": "204"},
{"type": "bookmark", "id": "192"},
{"type": "bookmark", "id": "210"}
{"type": "folder", "id": 17},
{"type": "bookmark", "id": 204},
{"type": "bookmark", "id": 192},
{"type": "bookmark", "id": 210}
]
}