个人 API

修改本人维护的资源

PATCH /v1/personal/resources/{slug}
PATCH/v1/personal/resources/{slug}
下载规范

Bearer 令牌(resource:update:self)

路径参数

slugstring必填

长度 ≥ 1

请求体 必填

application/json
titlestring可选

长度 ≥ 1 · 长度 ≤ 120

summarystring可选

长度 ≥ 1 · 长度 ≤ 200

bodystring可选

长度 ≥ 1 · 长度 ≤ 1000000

capabilitiesobject可选
[key]any可选
tagsstring | string[]可选

多值可重复传入同名参数,或用逗号分隔;同一筛选维度内满足任意值即可。

方案 1 · string

多值可重复传入同名参数,或用逗号分隔;同一筛选维度内满足任意值即可。

bodystring

多值可重复传入同名参数,或用逗号分隔;同一筛选维度内满足任意值即可。

方案 2 · string[]

多值可重复传入同名参数,或用逗号分隔;同一筛选维度内满足任意值即可。

bodystring[]

多值可重复传入同名参数,或用逗号分隔;同一筛选维度内满足任意值即可。

[]string
referencesobject[]可选

条目数 ≤ 200

[]object

方案 1 · object

relationstring可选

长度 ≤ 100

rolestring可选
kindstring可选
notestring可选
externalUrlstring可选

格式:uri

targetTypestring必填
可选值"resource""tutorial""post"
targetIdstring必填

方案 2 · object

relationstring可选

长度 ≤ 100

rolestring可选
kindstring可选
notestring可选
externalUrlstring可选

格式:uri

targetTypestring必填
可选值"resource""tutorial""post"
targetIdstring必填
fragmentTypestring必填
可选值"release""section""block"
fragmentIdstring必填

方案 3 · object

relationstring可选

长度 ≤ 100

rolestring可选
kindstring可选
notestring可选
externalUrlstring可选

格式:uri

externalNamestring必填

长度 ≥ 1 · 长度 ≤ 200

externalKeystring可选
statusstring可选
可选值"draft""published"

返回值

成功

okboolean必填
可选值true
接口信息

接口: PATCH /v1/personal/resources/{slug}
operationId: updateResource

所需权限: resource:update:self

参数:

  • path slug(必填)
  • body title
  • body summary
  • body body
  • body capabilities
  • body tags:多值可重复传入同名参数,或用逗号分隔;同一筛选维度内满足任意值即可。
  • body references
  • body status