修改¶

POST /api/v1/notes_v2/{note_uuid}/modify

概述¶

修改新版笔记。

路由参数¶

参数名	类型	必选	说明
note_uuid	string	Y	Studio 新版笔记 UUID

Body 请求参数¶

参数名	类型	必选	说明
title	string		笔记标题允许为空: False
content	string		Markdown 正文允许为空: False
tags	array		标签列表允许为空: False
tagKV	json		键值标签允许为空: False
isPublic	int		是否公开，1 公开，0 私有允许为空: False
ifMatch	string		可选 ETag，传入时转发给 NbookDB If-Match 允许为空: False
extend	json		Studio 业务扩展字段允许为空: False

参数补充说明¶

使用 URL 中的 note_uuid 修改笔记。请求体可传 title、content、tags、tagKV、isPublic 和 extend 中的一个或多个字段。

建议传入详情或上一次保存返回的 etag 作为 ifMatch。
只修改标题、标签或公开状态时可以不传 content。
修改成功后请使用响应中的新 etag 更新本地编辑状态。
私有笔记只有创建者可修改；公开笔记需要当前 API Key 具备写权限。

请求例子¶

curl 'https://openapi.guance.com/api/v1/notes_v2/nbnote_xxx/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"title":"A v2","content":"# A v2","ifMatch":"etag_xxx"}'

响应¶

{
    "code": 200,
    "content": {
        "noteUUID": "nbnote_xxx",
        "title": "A v2",
        "tags": [
            "ops"
        ],
        "tagKV": {
            "host": "127.0.0.2"
        },
        "isPublic": 1,
        "createdSource": "manual",
        "etag": "etag_new",
        "version": 2
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}