Notes API
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
Notes API 用于管理附加到 GitLab 内容的评论和系统记录。 Notes API 的功能:
- 在 issue、merge request、epic、snippet 和 commit 上创建和修改评论。
- 获取关于对象变更的系统生成的备注。
- 提供排序和分页选项。
- 通过机密和内部标志控制可见性。
- 支持速率限制以防止滥用。
某些系统生成的备注被跟踪为单独的资源事件:
默认情况下,GET 请求每次返回 20 个结果,因为 API 结果是分页的。
更多信息,请参见分页。
资源事件
某些系统备注不是此 API 的一部分,而是被记录为单独的事件:
备注分页
默认情况下,GET 请求每次返回 20 个结果,因为 API 结果是分页的。
阅读更多关于分页的信息。
速率限制
为帮助避免滥用,您可以将用户限制为每分钟特定数量的 Create 请求。
请参见备注速率限制。
Issues
列出项目 issue 备注获取单个 issue 的所有备注列表。
GET /projects/:id/issues/:issue_iid/notes
GET /projects/:id/issues/:issue_iid/notes?sort=asc&order_by=updated_at| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 项目的 ID 或URL 编码路径 |
issue_iid |
integer | 是 | issue 的 IID |
sort |
string | 否 | 按 asc 或 desc 顺序返回 issue 备注。默认为 desc |
order_by |
string | 否 | 按 created_at 或 updated_at 字段排序返回 issue 备注。默认为 created_at |
[
{
"id": 302,
"body": "closed",
"author": {
"id": 1,
"username": "pipin",
"email": "[email protected]",
"name": "Pip",
"state": "active",
"created_at": "2013-09-30T13:46:01Z"
},
"created_at": "2013-10-02T09:22:45Z",
"updated_at": "2013-10-02T10:22:45Z",
"system": true,
"noteable_id": 377,
"noteable_type": "Issue",
"project_id": 5,
"noteable_iid": 377,
"resolvable": false,
"confidential": false,
"internal": false,
"imported": false,
"imported_from": "none"
},
{
"id": 305,
"body": "Text of the comment\r\n",
"author": {
"id": 1,
"username": "pipin",
"email": "[email protected]",
"name": "Pip",
"state": "active",
"created_at": "2013-09-30T13:46:01Z"
},
"created_at": "2013-10-02T09:56:03Z",
"updated_at": "2013-10-02T09:56:03Z",
"system": true,
"noteable_id": 121,
"noteable_type": "Issue",
"project_id": 5,
"noteable_iid": 121,
"resolvable": false,
"confidential": true,
"internal": true,
"imported": false,
"imported_from": "none"
}
]curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/issues/11/notes"获取单个 issue 备注返回特定项目 issue 的单个备注
GET /projects/:id/issues/:issue_iid/notes/:note_id参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 项目的 ID 或URL 编码路径 |
issue_iid |
integer | 是 | 项目 issue 的 IID |
note_id |
integer | 是 | issue 备注的 ID |
curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/issues/11/notes/1"创建新的 issue 备注为单个项目 issue 创建新备注。
POST /projects/:id/issues/:issue_iid/notes参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 项目的 ID 或URL 编码路径。 |
issue_iid |
integer | 是 | issue 的 IID。 |
body |
string | 是 | 备注的内容。限制为 1,000,000 个字符。 |
confidential |
boolean | 否 | 已弃用:计划在 GitLab 16.0 中移除并重命名为 internal。备注的机密标志。默认为 false。 |
internal |
boolean | 否 | 备注的内部标志。当同时提交两个参数时,会覆盖 confidential。默认为 false。 |
created_at |
string | 否 | 日期时间字符串,ISO 8601 格式。必须晚于 1970-01-01。示例:2016-03-11T03:45:40Z(需要管理员或项目/组所有者权限) |
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/issues/11/notes?body=note"修改现有的 issue 备注修改 issue 的现有备注。
PUT /projects/:id/issues/:issue_iid/notes/:note_id参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 项目的 ID 或URL 编码路径。 |
issue_iid |
integer | 是 | issue 的 IID。 |
note_id |
integer | 是 | 备注的 ID。 |
body |
string | 否 | 备注的内容。限制为 1,000,000 个字符。 |
confidential |
boolean | 否 | 已弃用:计划在 GitLab 16.0 中移除。备注的机密标志。默认为 false。 |
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/issues/11/notes/636?body=note"删除 issue 备注删除 issue 的现有备注。
DELETE /projects/:id/issues/:issue_iid/notes/:note_id参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 项目的 ID 或URL 编码路径 |
issue_iid |
integer | 是 | issue 的 IID |
note_id |
integer | 是 | 备注的 ID |
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/issues/11/notes/636"Snippets
Snippets Notes API 适用于项目级别的 snippet,不适用于个人 snippet。
列出所有 snippet 备注获取单个 snippet 的所有备注列表。Snippet 备注是用户可以发布到 snippet 的评论。
GET /projects/:id/snippets/:snippet_id/notes
GET /projects/:id/snippets/:snippet_id/notes?sort=asc&order_by=updated_at| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 项目的 ID 或URL 编码路径 |
snippet_id |
integer | 是 | 项目 snippet 的 ID |
sort |
string | 否 | 按 asc 或 desc 顺序返回 snippet 备注。默认为 desc |
order_by |
string | 否 | 按 created_at 或 updated_at 字段排序返回 snippet 备注。默认为 created_at |
curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/snippets/11/notes"获取单个 snippet 备注返回给定 snippet 的单个备注。
GET /projects/:id/snippets/:snippet_id/notes/:note_id参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 项目的 ID 或URL 编码路径 |
snippet_id |
integer | 是 | 项目 snippet 的 ID |
note_id |
integer | 是 | snippet 备注的 ID |
{
"id": 302,
"body": "closed",
"author": {
"id": 1,
"username": "pipin",
"email": "[email protected]",
"name": "Pip",
"state": "active",
"created_at": "2013-09-30T13:46:01Z"
},
"created_at": "2013-10-02T09:22:45Z",
"updated_at": "2013-10-02T10:22:45Z",
"system": true,
"noteable_id": 377,
"noteable_type": "Issue",
"project_id": 5,
"noteable_iid": 377,
"resolvable": false,
"confidential": false,
"internal": false,
"imported": false,
"imported_from": "none"
}curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/snippets/11/notes/11"创建新的 snippet 备注为单个 snippet 创建新备注。Snippet 备注是用户对 snippet 的评论。
如果您创建的备注内容仅包含表情符号反应,GitLab 会返回此对象。
POST /projects/:id/snippets/:snippet_id/notes参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 项目的 ID 或URL 编码路径 |
snippet_id |
integer | 是 | snippet 的 ID |
body |
string | 是 | 备注的内容。限制为 1,000,000 个字符。 |
created_at |
string | 否 | 日期时间字符串,ISO 8601 格式。示例:2016-03-11T03:45:40Z(需要管理员或项目/组所有者权限) |
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/snippet/11/notes?body=note"修改现有的 snippet 备注修改 snippet 的现有备注。
PUT /projects/:id/snippets/:snippet_id/notes/:note_id参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 项目的 ID 或URL 编码路径 |
snippet_id |
integer | 是 | snippet 的 ID |
note_id |
integer | 是 | snippet 备注的 ID |
body |
string | 是 | 备注的内容。限制为 1,000,000 个字符。 |
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/snippets/11/notes/1659?body=note"删除 snippet 备注删除 snippet 的现有备注。
DELETE /projects/:id/snippets/:snippet_id/notes/:note_id参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 项目的 ID 或URL 编码路径 |
snippet_id |
integer | 是 | snippet 的 ID |
note_id |
integer | 是 | 备注的 ID |
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/snippets/52/notes/1659"Merge requests
列出所有 merge request 备注获取单个 merge request 的所有备注列表。
GET /projects/:id/merge_requests/:merge_request_iid/notes
GET /projects/:id/merge_requests/:merge_request_iid/notes?sort=asc&order_by=updated_at| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 项目的 ID 或URL 编码路径 |
merge_request_iid |
integer | 是 | 项目 merge request 的 IID |
sort |
string | 否 | 按 asc 或 desc 顺序返回 merge request 备注。默认为 desc |
order_by |
string | 否 | 按 created_at 或 updated_at 字段排序返回 merge request 备注。默认为 created_at |
curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes"获取单个 merge request 备注返回给定 merge request 的单个备注。
GET /projects/:id/merge_requests/:merge_request_iid/notes/:note_id参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 项目的 ID 或URL 编码路径 |
merge_request_iid |
integer | 是 | 项目 merge request 的 IID |
note_id |
integer | 是 | merge request 备注的 ID |
{
"id": 301,
"body": "Comment for MR",
"author": {
"id": 1,
"username": "pipin",
"email": "[email protected]",
"name": "Pip",
"state": "active",
"created_at": "2013-09-30T13:46:01Z"
},
"created_at": "2013-10-02T08:57:14Z",
"updated_at": "2013-10-02T08:57:14Z",
"system": false,
"noteable_id": 2,
"noteable_type": "MergeRequest",
"project_id": 5,
"noteable_iid": 2,
"resolvable": false,
"confidential": false,
"internal": false
}curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes/1"创建新的 merge request 备注为单个 merge request 创建新备注。备注不会附加到 merge request 中的特定行。
对于具有更精细控制的其他方法,请参见 Commits API 中的向 commit 发布评论, 以及 Discussions API 中的在 merge request diff 中创建新线程。
如果您创建的备注内容仅包含表情符号反应,GitLab 会返回此对象。
POST /projects/:id/merge_requests/:merge_request_iid/notes参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
body |
string | 是 | 备注的内容。限制为 1,000,000 个字符。 |
id |
integer 或 string | 是 | 项目的 ID 或URL 编码路径 |
merge_request_iid |
integer | 是 | 项目 merge request 的 IID |
created_at |
string | 否 | 日期时间字符串,ISO 8601 格式。示例:2016-03-11T03:45:40Z(需要管理员或项目/组所有者权限) |
internal |
boolean | 否 | 备注的内部标志。默认为 false。 |
merge_request_diff_head_sha |
string | 否 | /merge 快速操作需要。头部 commit 的 SHA,确保 merge request 在 API 请求发送后未被更新。 |
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes?body=note"修改现有的 merge request 备注修改 merge request 的现有备注。
PUT /projects/:id/merge_requests/:merge_request_iid/notes/:note_id参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 项目的 ID 或URL 编码路径 |
merge_request_iid |
integer | 是 | 项目 merge request 的 IID |
note_id |
integer | 否 | 备注的 ID |
body |
string | 是 | 备注的内容。限制为 1,000,000 个字符。 |
confidential |
boolean | 否 | 已弃用:计划在 GitLab 16.0 中移除。备注的机密标志。默认为 false。 |
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes/1?body=note"删除 merge request 备注删除 merge request 的现有备注。
DELETE /projects/:id/merge_requests/:merge_request_iid/notes/:note_id参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 项目的 ID 或URL 编码路径 |
merge_request_iid |
integer | 是 | merge request 的 IID |
note_id |
integer | 是 | 备注的 ID |
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/merge_requests/7/notes/1602"Epics
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
Epics REST API 在 GitLab 17.0 中已弃用, 并计划在 API v5 中移除。 从 GitLab 17.4 到 18.0,如果启用了epics 的新外观,以及在 GitLab 18.1 及更高版本中, 请改用 Work Items API。更多信息,请参见将 epic API 迁移到 work items。 此更改是一个破坏性更改。
列出所有 epic 备注获取单个 epic 的所有备注列表。Epic 备注是用户可以发布到 epic 的评论。
epics 备注 API 使用 epic ID 而不是 epic IID。如果您使用 epic 的 IID,GitLab 会返回 404 错误或错误 epic 的备注。 这与issue 备注 API和merge requests 备注 API不同。
GET /groups/:id/epics/:epic_id/notes
GET /groups/:id/epics/:epic_id/notes?sort=asc&order_by=updated_at| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 组的 ID 或URL 编码路径 |
epic_id |
integer | 是 | 组 epic 的 ID |
sort |
string | 否 | 按 asc 或 desc 顺序返回 epic 备注。默认为 desc |
order_by |
string | 否 | 按 created_at 或 updated_at 字段排序返回 epic 备注。默认为 created_at |
curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/5/epics/11/notes"获取单个 epic 备注返回给定 epic 的单个备注。
GET /groups/:id/epics/:epic_id/notes/:note_id参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 组的 ID 或URL 编码路径 |
epic_id |
integer | 是 | epic 的 ID |
note_id |
integer | 是 | 备注的 ID |
{
"id": 302,
"body": "Epic note",
"author": {
"id": 1,
"username": "pipin",
"email": "[email protected]",
"name": "Pip",
"state": "active",
"created_at": "2013-09-30T13:46:01Z"
},
"created_at": "2013-10-02T09:22:45Z",
"updated_at": "2013-10-02T10:22:45Z",
"system": true,
"noteable_id": 11,
"noteable_type": "Epic",
"project_id": 5,
"noteable_iid": 11,
"resolvable": false,
"confidential": false,
"internal": false,
"imported": false,
"imported_from": "none"
}curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/5/epics/11/notes/1"创建新的 epic 备注为单个 epic 创建新备注。Epic 备注是用户可以发布到 epic 的评论。
如果您创建的备注内容仅包含表情符号反应,GitLab 会返回此对象。
POST /groups/:id/epics/:epic_id/notes参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
body |
string | 是 | 备注的内容。限制为 1,000,000 个字符。 |
epic_id |
integer | 是 | epic 的 ID |
id |
integer 或 string | 是 | 组的 ID 或URL 编码路径 |
confidential |
boolean | 否 | 已弃用:计划在 GitLab 16.0 中移除并重命名为 internal。备注的机密标志。默认为 false。 |
internal |
boolean | 否 | 备注的内部标志。当同时提交两个参数时,会覆盖 confidential。默认为 false。 |
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/5/epics/11/notes?body=note"修改现有的 epic 备注修改 epic 的现有备注。
PUT /groups/:id/epics/:epic_id/notes/:note_id参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 组的 ID 或URL 编码路径 |
epic_id |
integer | 是 | epic 的 ID |
note_id |
integer | 是 | 备注的 ID |
body |
string | 是 | 备注的内容。限制为 1,000,000 个字符。 |
confidential |
boolean | 否 | 已弃用:计划在 GitLab 16.0 中移除。备注的机密标志。默认为 false。 |
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/5/epics/11/notes/1?body=note"删除 epic 备注删除 epic 的现有备注。
DELETE /groups/:id/epics/:epic_id/notes/:note_id参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 组的 ID 或URL 编码路径 |
epic_id |
integer | 是 | epic 的 ID |
note_id |
integer | 是 | 备注的 ID |
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/5/epics/52/notes/1659"Project wikis
列出所有项目 wiki 备注获取项目 wiki 页面的所有备注列表。项目 wiki 备注是用户可以发布到 wiki 页面的评论。
wiki 页面备注 API 使用 wiki 页面 meta ID 而不是 wiki 页面 slug。如果您使用页面的 slug,GitLab 会返回 404 错误。 您可以从项目 wikis API中检索 meta ID。
GET /projects/:id/wiki_pages/:wiki_page_meta_id/notes
GET /projects/:id/wiki_pages/:wiki_page_meta_id/notes?sort=asc&order_by=updated_at参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 项目的 ID 或URL 编码路径 |
wiki_page_meta_id |
integer | 是 | wiki 页面 meta 的 ID |
sort |
string | 否 | 按 asc 或 desc 顺序返回 wiki 页面备注。默认为 desc |
order_by |
string | 否 | 按 created_at 或 updated_at 字段排序返回 wiki 页面备注。默认为 created_at |
curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/wiki_pages/35/notes"获取单个 wiki 页面备注返回给定 wiki 页面的单个备注。
GET /projects/:id/wiki_pages/:wiki_page_meta_id/notes/:note_id参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 项目的 ID 或URL 编码路径 |
wiki_page_meta_id |
integer | 是 | wiki 页面 meta 的 ID |
note_id |
integer | 是 | 备注的 ID |
{
"author": {
"id": 1,
"username": "pipin",
"email": "[email protected]",
"name": "Pip",
"state": "active",
"created_at": "2013-09-30T13:46:01Z"
},
"body": "foobar",
"commands_changes": {},
"confidential": false,
"created_at": "2025-03-11T11:36:32.222Z",
"id": 1218,
"imported": false,
"imported_from": "none",
"internal": false,
"noteable_id": 35,
"noteable_iid": null,
"noteable_type": "WikiPage::Meta",
"project_id": 5,
"resolvable": false,
"system": false,
"type": null,
"updated_at": "2025-03-11T11:36:32.222Z"
}curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/wiki_pages/35/notes/1218"创建新的 wiki 页面备注为单个 wiki 页面创建新备注。Wiki 页面备注是用户可以发布到 wiki 页面的评论。
POST /projects/:id/wiki_pages/:wiki_page_meta_id/notes参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
body |
string | 是 | 备注的内容。限制为 1,000,000 个字符。 |
wiki_page_meta_id |
integer | 是 | wiki 页面 meta 的 ID |
id |
integer 或 string | 是 | 项目的 ID 或URL 编码路径 |
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/wiki_pages/35/notes?body=note"修改现有的 wiki 页面备注修改 wiki 页面上的现有备注。
PUT /projects/:id/wiki_pages/:wiki_page_meta_id/notes/:note_id参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 项目的 ID 或URL 编码路径 |
wiki_page_meta_id |
integer | 是 | wiki 页面 meta 的 ID |
note_id |
integer | 是 | 备注的 ID |
body |
string | 是 | 备注的内容。限制为 1,000,000 个字符。 |
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/wiki_pages/35/notes/1218?body=note"删除 wiki 页面备注从 wiki 页面删除备注。
DELETE /projects/:id/wiki_pages/:wiki_page_meta_id/notes/:note_id参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 项目的 ID 或URL 编码路径 |
wiki_page_meta_id |
integer | 是 | wiki 页面 meta 的 ID |
note_id |
integer | 是 | 备注的 ID |
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/wiki_pages/35/notes/1218"Group wikis
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
列出所有组 wiki 备注获取组 wiki 页面的所有备注列表。组 wiki 备注是用户可以发布到 wiki 页面的评论。
wiki 页面备注 API 使用 wiki 页面 meta ID 而不是 wiki 页面 slug。如果您使用页面的 slug,GitLab 会返回 404 错误。 您可以从组 wikis API中检索 meta ID。
GET /groups/:id/wiki_pages/:wiki_page_meta_id/notes
GET /groups/:id/wiki_pages/:wiki_page_meta_id/notes?sort=asc&order_by=updated_at| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 组的 ID 或URL 编码路径 |
wiki_page_meta_id |
integer | 是 | wiki 页面 meta 的 ID |
sort |
string | 否 | 按 asc 或 desc 顺序返回 wiki 页面备注。默认为 desc |
order_by |
string | 否 | 按 created_at 或 updated_at 字段排序返回 wiki 页面备注。默认为 created_at |
curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/5/wiki_pages/35/notes"获取单个 wiki 页面备注返回给定 wiki 页面的单个备注。
GET /groups/:id/wiki_pages/:wiki_page_meta_id/notes/:note_id参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 组的 ID 或URL 编码路径 |
wiki_page_meta_id |
integer | 是 | wiki 页面 meta 的 ID |
note_id |
integer | 是 | 备注的 ID |
{
"author": {
"id": 1,
"username": "pipin",
"email": "[email protected]",
"name": "Pip",
"state": "active",
"created_at": "2013-09-30T13:46:01Z"
},
"body": "foobar",
"commands_changes": {},
"confidential": false,
"created_at": "2025-03-11T11:36:32.222Z",
"id": 1218,
"imported": false,
"imported_from": "none",
"internal": false,
"noteable_id": 35,
"noteable_iid": null,
"noteable_type": "WikiPage::Meta",
"project_id": null,
"resolvable": false,
"system": false,
"type": null,
"updated_at": "2025-03-11T11:36:32.222Z"
}curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/5/wiki_pages/35/notes/1218"创建新的 wiki 页面备注为单个 wiki 页面创建新备注。Wiki 页面备注是用户可以发布到 wiki 页面的评论。
POST /groups/:id/wiki_pages/:wiki_page_meta_id/notes参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
body |
string | 是 | 备注的内容。限制为 1,000,000 个字符。 |
wiki_page_meta_id |
integer | 是 | wiki 页面 meta 的 ID |
id |
integer 或 string | 是 | 组的 ID 或URL 编码路径 |
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/5/wiki_pages/35/notes?body=note"修改现有的 wiki 页面备注修改 wiki 页面上的现有备注。
PUT /groups/:id/wiki_pages/:wiki_page_meta_id/notes/:note_id参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 组的 ID 或URL 编码路径 |
wiki_page_meta_id |
integer | 是 | wiki 页面 meta 的 ID |
note_id |
integer | 是 | 备注的 ID |
body |
string | 是 | 备注的内容。限制为 1,000,000 个字符。 |
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/5/wiki_pages/35/notes/1218?body=note"删除 wiki 页面备注从 wiki 页面删除备注。
DELETE /groups/:id/wiki_pages/:wiki_page_meta_id/notes/:note_id参数:
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer 或 string | 是 | 组的 ID 或URL 编码路径 |
wiki_page_meta_id |
integer | 是 | wiki 页面 meta 的 ID |
note_id |
integer | 是 | 备注的 ID |
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/groups/5/wiki_pages/35/notes/1218"