Explorar el Código

:art: Add kernel API `/api/block/foldBlock` and `/api/block/unfoldBlock` https://github.com/siyuan-note/siyuan/issues/9962

Daniel hace 1 año
padre
commit
584168acdb
Se han modificado 2 ficheros con 92 adiciones y 0 borrados
  1. 46 0
      API.md
  2. 46 0
      API_zh_CN.md

+ 46 - 0
API.md

@@ -28,6 +28,8 @@
     * [Update a block](#Update-a-block)
     * [Delete a block](#Delete-a-block)
     * [Move a block](#Move-a-block)
+    * [Fold a block](#Fold-a-block)
+    * [Unfold a block](#Unfold-a-block)
     * [Get a block kramdown](#Get-a-block-kramdown)
     * [Get child blocks](#get-child-blocks)
     * [Transfer block ref](#transfer-block-ref)
@@ -783,6 +785,50 @@ View API token in <kbd>Settings - About</kbd>, request header: `Authorization: T
   }
   ```
 
+### Fold a block
+
+* `/api/block/foldBlock`
+* Parameters
+
+  ```json
+  {
+    "id": "20231224160424-2f5680o"
+  }
+  ```
+
+  * `id`: Block ID to fold
+* Return value
+
+  ```json
+  {
+    "code": 0,
+    "msg": "",
+    "data": null
+  }
+  ```
+
+### Unfold a block
+
+* `/api/block/unfoldBlock`
+* Parameters
+
+  ```json
+  {
+    "id": "20231224160424-2f5680o"
+  }
+  ```
+
+  * `id`: Block ID to unfold
+* Return value
+
+  ```json
+  {
+    "code": 0,
+    "msg": "",
+    "data": null
+  }
+  ```
+
 ### Get a block kramdown
 
 * `/api/block/getBlockKramdown`

+ 46 - 0
API_zh_CN.md

@@ -29,6 +29,8 @@
     * [更新块](#更新块)
     * [删除块](#删除块)
     * [移动块](#移动块)
+    * [折叠块](#折叠块)
+    * [展开块](#展开块)
     * [获取块 kramdown 源码](#获取块-kramdown-源码)
     * [获取子块](#获取子块)
     * [转移块引用](#转移块引用)
@@ -776,6 +778,50 @@
   }
   ```
 
+### 折叠块
+
+* `/api/block/foldBlock`
+* 参数
+
+  ```json
+  {
+    "id": "20231224160424-2f5680o"
+  }
+  ```
+
+  * `id`:待折叠块的 ID
+* 返回值
+
+  ```json
+  {
+    "code": 0,
+    "msg": "",
+    "data": null
+  }
+  ```
+
+### 展开块
+
+* `/api/block/unfoldBlock`
+* 参数
+
+  ```json
+  {
+    "id": "20231224160424-2f5680o"
+  }
+  ```
+
+  * `id`:待展开块的 ID
+* 返回值
+
+  ```json
+  {
+    "code": 0,
+    "msg": "",
+    "data": null
+  }
+  ```
+
 ### 获取块 kramdown 源码
 
 * `/api/block/getBlockKramdown`