github/siyuan
4
0
Fork 0
mirror of https://github.com/siyuan-note/siyuan.git synced 2025-05-02 08:01:59 +08:00
Code Issues Packages Projects Releases Wiki Activity

🎨 Add a new API Move block https://github.com/siyuan-note/siyuan/issues/7903

Browse Source
This commit is contained in:
Liang Ding 2023-04-06 18:29:44 +08:00
parent 9a98ba015f
commit 1a09c04b92
No known key found for this signature in database
GPG Key ID: 136F30F901A2231D
2 changed files with 90 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
API.md
View File

@ -27,6 +27,7 @@
* [Append blocks](#Append-blocks) * [Append blocks](#Append-blocks)
* [Update a block](#Update-a-block) * [Update a block](#Update-a-block)
* [Delete a block](#Delete-a-block) * [Delete a block](#Delete-a-block)
* [Move a block](#Move-a-block)
* [Get a block kramdown](#Get-a-block-kramdown) * [Get a block kramdown](#Get-a-block-kramdown)
* [Attributes](#Attributes) * [Attributes](#Attributes)
* [Set block attributes](#Set-block-attributes) * [Set block attributes](#Set-block-attributes)
@ -696,6 +697,50 @@ View API token in <kbd>Settings - About</kbd>, request header: `Authorization: T
} }
``` ```
### Move a block
* `/api/block/moveBlock`
* Parameters
```json
{
"id": "20230406180530-3o1rqkc",
"previousID": "20230406152734-if5kyx6",
"parentID": "20230404183855-woe52ko"
}
```
* `id`: Block ID to move
* `previousID`: The ID of the previous block, used to anchor the insertion position
* `parentID`: The ID of the parent block, used to anchor the insertion position, `previousID` and `parentID` cannot be empty at the same time, if they exist at the same time, `previousID` will be used first
* Return value
```json
{
"code": 0,
"msg": "",
"data": [
{
"doOperations": [
{
"action": "move",
"data": null,
"id": "20230406180530-3o1rqkc",
"parentID": "20230404183855-woe52ko",
"previousID": "20230406152734-if5kyx6",
"nextID": "",
"retData": null,
"srcIDs": null,
"name": "",
"type": ""
}
],
"undoOperations": null
}
]
}
```
### Get a block kramdown ### Get a block kramdown
* `/api/block/getBlockKramdown` * `/api/block/getBlockKramdown`

45
API_zh_CN.md
View File

@ -27,6 +27,7 @@
* [插入后置子块](#插入后置子块) * [插入后置子块](#插入后置子块)
* [更新块](#更新块) * [更新块](#更新块)
* [删除块](#删除块) * [删除块](#删除块)
* [移动块](#移动块)
* [获取块 kramdown 源码](#获取块-kramdown-源码) * [获取块 kramdown 源码](#获取块-kramdown-源码)
* [属性](#属性) * [属性](#属性)
* [设置块属性](#设置块属性) * [设置块属性](#设置块属性)
@ -690,6 +691,50 @@
} }
``` ```
### 移动块
* `/api/block/moveBlock`
* 参数
```json
{
"id": "20230406180530-3o1rqkc",
"previousID": "20230406152734-if5kyx6",
"parentID": "20230404183855-woe52ko"
}
```
* `id`：待移动块 ID
* `previousID`：前一个块的 ID，用于锚定插入位置
* `parentID`：父块的 ID，用于锚定插入位置，`previousID` 和 `parentID` 不能同时为空，同时存在的话优先使用 `previousID`
* 返回值
```json
{
"code": 0,
"msg": "",
"data": [
{
"doOperations": [
{
"action": "move",
"data": null,
"id": "20230406180530-3o1rqkc",
"parentID": "20230404183855-woe52ko",
"previousID": "20230406152734-if5kyx6",
"nextID": "",
"retData": null,
"srcIDs": null,
"name": "",
"type": ""
}
],
"undoOperations": null
}
]
}
```
### 获取块 kramdown 源码 ### 获取块 kramdown 源码
* `/api/block/getBlockKramdown` * `/api/block/getBlockKramdown`