讨论 API

讨论是以下实体中评论的集合：

代码片段
议题
史诗
合并请求
提交

包括标准和主题评论和系统评论。系统评论是关于对象更改的评论（例如，当里程碑更改时）。标记评论不被包含在此 API 中，而是作为单独的事件记录在资源标签事件中。

讨论分页

默认情况下，GET 请求一次返回 20 个结果，因为 API 返回的结果是经过分页的。

阅读更多关于分页的内容。

议题

项目议题主题列表

获取单个议题的所有主题列表。

GET /projects/:id/issues/:issue_iid/discussions

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`issue_iid`	integer	yes	议题的 IID

[
  {
    "id": "6a9c1750b37d513a43987b574953fceb50b03ce7",
    "individual_note": false,
    "notes": [
      {
        "id": 1126,
        "type": "DiscussionNote",
        "body": "discussion text",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-03T21:54:39.668Z",
        "updated_at": "2018-03-03T21:54:39.668Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Issue",
        "noteable_iid": null
      },
      {
        "id": 1129,
        "type": "DiscussionNote",
        "body": "reply to the discussion",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T13:38:02.127Z",
        "updated_at": "2018-03-04T13:38:02.127Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Issue",
        "noteable_iid": null,
        "resolvable": false
      }
    ]
  },
  {
    "id": "87805b7c09016a7058e91bdbe7b29d1f284a39e6",
    "individual_note": true,
    "notes": [
      {
        "id": 1128,
        "type": null,
        "body": "a single comment",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T09:17:22.520Z",
        "updated_at": "2018-03-04T09:17:22.520Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Issue",
        "noteable_iid": null,
        "resolvable": false
      }
    ]
  }
]

curl --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/issues/11/discussions"

获得议题的单个讨论

返回特定项目议题的单个讨论。

GET /projects/:id/issues/:issue_iid/discussions/:discussion_id

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`issue_iid`	integer	yes	议题的 IID
`discussion_id`	integer	yes	讨论项的 ID

curl --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/issues/11/discussions/<discussion_id>"

创建新的议题主题

为单个项目议题创建新主题。这类似于创建一个评论，不同的是可以在主题中添加新评论（回复）。

POST /projects/:id/issues/:issue_iid/discussions

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`issue_iid`	integer	yes	议题的 IID
`body`	string	yes	主题的内容
`created_at`	string	no	日期时间字符串，ISO 8601 格式，如：`2016-03-11T03:45:40Z` （需要管理员或项目/组所有者的权限）

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/issues/11/discussions?body=comment"

添加评论到现有议题的主题

为现有主题添加评论，也可以从一个评论创建一个主题。

评论可以添加到标准评论之外的其他项目中，例如系统注释，使它们成为一个主题。

POST /projects/:id/issues/:issue_iid/discussions/:discussion_id/notes

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`issue_iid`	integer	yes	议题的 IID
`discussion_id`	integer	yes	主题的 ID
`note_id`	integer	yes	主题评论的 ID
`body`	string	yes	评论或回复的内容
`created_at`	string	no	日期时间字符串，ISO 8601 格式，如： `2016-03-11T03:45:40Z` （需要管理员或项目/组所有者的权限）

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/issues/11/discussions/<discussion_id>/notes?body=comment"

修改现有议题主题中的评论

修改一个议题中已经存在的主题的评论。

PUT /projects/:id/issues/:issue_iid/discussions/:discussion_id/notes/:note_id

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`issue_iid`	integer	yes	议题的 IID
`discussion_id`	integer	yes	主题的 ID
`note_id`	integer	yes	主题评论的 ID
`body`	string	yes	评论或回复的内容

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/issues/11/discussions/<discussion_id>/notes/1108?body=comment"

删除一个议题主题的评论

删除一个议题中已经存在的主题的评论。

DELETE /projects/:id/issues/:issue_iid/discussions/:discussion_id/notes/:note_id

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`issue_iid`	integer	yes	议题的 IID
`discussion_id`	integer	yes	讨论的 ID
`note_id`	integer	yes	讨论评论的 ID

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/issues/11/discussions/636"

代码片

项目代码片主题列表

获取单个代码片的所有主题列表。

GET /projects/:id/snippets/:snippet_id/discussions

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`snippet_id`	integer	yes	代码片的 ID

[
  {
    "id": "6a9c1750b37d513a43987b574953fceb50b03ce7",
    "individual_note": false,
    "notes": [
      {
        "id": 1126,
        "type": "DiscussionNote",
        "body": "discussion text",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-03T21:54:39.668Z",
        "updated_at": "2018-03-03T21:54:39.668Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Snippet",
        "noteable_iid": null
      },
      {
        "id": 1129,
        "type": "DiscussionNote",
        "body": "reply to the discussion",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T13:38:02.127Z",
        "updated_at": "2018-03-04T13:38:02.127Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Snippet",
        "noteable_iid": null,
        "resolvable": false
      }
    ]
  },
  {
    "id": "87805b7c09016a7058e91bdbe7b29d1f284a39e6",
    "individual_note": true,
    "notes": [
      {
        "id": 1128,
        "type": null,
        "body": "a single comment",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T09:17:22.520Z",
        "updated_at": "2018-03-04T09:17:22.520Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Snippet",
        "noteable_iid": null,
        "resolvable": false
      }
    ]
  }
]

curl --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions"

获得代码片的单个讨论

返回特定项目代码片的单个讨论。

GET /projects/:id/snippets/:snippet_id/discussions/:discussion_id

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`snippet_id`	integer	yes	代码片的 ID
`discussion_id`	integer	yes	讨论项的 ID

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions/<discussion_id>"

创建新的代码片主题

为单个项目议题创建新主题。这类似于创建一个评论，不同的是可以在主题中添加新评论（回复）。

POST /projects/:id/snippets/:snippet_id/discussions

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`snippet_id`	integer	yes	代码片的 ID
`body`	string	yes	讨论的内容
`created_at`	string	no	日期时间字符串，ISO 8601 格式，如： `2016-03-11T03:45:40Z` （需要管理员或项目/组所有者的权限）

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions?body=comment"

添加评论到现有代码片的主题

为现有主题添加评论。

POST /projects/:id/snippets/:snippet_id/discussions/:discussion_id/notes

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`snippet_id`	integer	yes	代码片的 ID
`discussion_id`	integer	yes	主题的 ID
`note_id`	integer	yes	主题评论的 ID
`body`	string	yes	评论或回复的内容
`created_at`	string	no	日期时间字符串，ISO 8601 格式，如： `2016-03-11T03:45:40Z` （需要管理员或项目/组所有者的权限）

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions/<discussion_id>/notes?body=comment"

修改现有代码片主题中的评论

修改一个代码片中已经存在的主题的评论。

PUT /projects/:id/snippets/:snippet_id/discussions/:discussion_id/notes/:note_id

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`snippet_id`	integer	yes	代码片的 ID
`discussion_id`	integer	yes	主题的 ID
`note_id`	integer	yes	主题评论的 ID
`body`	string	yes	评论或回复的内容

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions/<discussion_id>/notes/1108?body=comment"

删除一个代码片主题的评论

删除一个代码片中已经存在的主题的评论。

DELETE /projects/:id/snippets/:snippet_id/discussions/:discussion_id/notes/:note_id

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`snippet_id`	integer	yes	代码片的 ID
`discussion_id`	integer	yes	讨论的 ID
`note_id`	integer	yes	讨论评论的 ID

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions/636"

史诗

群组史诗主题列表

获取单个史诗的所有主题列表。

GET /groups/:id/epics/:epic_id/discussions

参数	类型	是否必需	描述
`id`	integer/string	yes	群组的 ID 或 URL 编码的路径
`epic_id`	integer	yes	史诗的 ID

[
  {
    "id": "6a9c1750b37d513a43987b574953fceb50b03ce7",
    "individual_note": false,
    "notes": [
      {
        "id": 1126,
        "type": "DiscussionNote",
        "body": "discussion text",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-03T21:54:39.668Z",
        "updated_at": "2018-03-03T21:54:39.668Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Epic",
        "noteable_iid": null,
        "resolvable": false
      },
      {
        "id": 1129,
        "type": "DiscussionNote",
        "body": "reply to the discussion",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T13:38:02.127Z",
        "updated_at": "2018-03-04T13:38:02.127Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Epic",
        "noteable_iid": null,
        "resolvable": false
      }
    ]
  },
  {
    "id": "87805b7c09016a7058e91bdbe7b29d1f284a39e6",
    "individual_note": true,
    "notes": [
      {
        "id": 1128,
        "type": null,
        "body": "a single comment",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T09:17:22.520Z",
        "updated_at": "2018-03-04T09:17:22.520Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Epic",
        "noteable_iid": null,
        "resolvable": false
      }
    ]
  }
]

curl --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/groups/5/epics/11/discussions"

获得史诗的单个讨论

返回特定群组史诗的单个讨论。

GET /groups/:id/epics/:epic_id/discussions/:discussion_id

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	群组的 ID 或 URL 编码的路径
`epic_id`	integer	yes	史诗的 ID
`discussion_id`	integer	yes	讨论项的 ID

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/groups/5/epics/11/discussions/<discussion_id>"

创建新的史诗主题

为单个群组史诗创建新主题。这类似于创建一个评论，不同的是可以在主题中添加新评论（回复）。

POST /groups/:id/epics/:epic_id/discussions

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	群组的 ID 或 URL 编码的路径
`epic_id`	integer	yes	史诗的 ID
`body`	string	yes	主题的内容
`created_at`	string	no	日期时间字符串，ISO 8601 格式，如：`2016-03-11T03:45:40Z` （需要管理员或项目/组所有者的权限）

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/groups/5/epics/11/discussions?body=comment"

添加评论到现有史诗的主题

为现有主题添加评论，也可以从一个评论创建一个主题。

POST /groups/:id/epics/:epic_id/discussions/:discussion_id/notes

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	群组的 ID 或 URL 编码的路径
`epic_id`	integer	yes	史诗的 ID
`discussion_id`	integer	yes	主题的 ID
`note_id`	integer	yes	主题评论的 ID
`body`	string	yes	评论或回复的内容
`created_at`	string	no	日期时间字符串，ISO 8601 格式，如： `2016-03-11T03:45:40Z` （需要管理员或项目/组所有者的权限）

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/groups/5/epics/11/discussions/<discussion_id>/notes?body=comment"

修改现有史诗主题中的评论

修改一个史诗中已经存在的主题的评论。

PUT /groups/:id/epics/:epic_id/discussions/:discussion_id/notes/:note_id

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	群组的 ID 或 URL 编码的路径
`epic_id`	integer	yes	史诗的 ID
`discussion_id`	integer	yes	主题的 ID
`note_id`	integer	yes	主题评论的 ID
`body`	string	yes	评论或回复的内容

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/groups/5/epics/11/discussions/<discussion_id>/notes/1108?body=comment"

删除一个史诗主题的评论

删除一个史诗中已经存在的主题的评论。

DELETE /groups/:id/epics/:epic_id/discussions/:discussion_id/notes/:note_id

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	群组的 ID 或 URL 编码的路径
`epic_id`	integer	yes	史诗的 ID
`discussion_id`	integer	yes	主题的 ID
`note_id`	integer	yes	主题评论的 ID

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/groups/5/epics/11/discussions/636"

合并请求

项目合并请求主题列表

获取单个合并请求的所有主题列表。

GET /projects/:id/merge_requests/:merge_request_iid/discussions

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`merge_request_iid`	integer	yes	合并请求的 IID

[
  {
    "id": "6a9c1750b37d513a43987b574953fceb50b03ce7",
    "individual_note": false,
    "notes": [
      {
        "id": 1126,
        "type": "DiscussionNote",
        "body": "discussion text",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-03T21:54:39.668Z",
        "updated_at": "2018-03-03T21:54:39.668Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Merge request",
        "noteable_iid": null,
        "resolved": false,
        "resolvable": true,
        "resolved_by": null,
        "resolved_at": null
      },
      {
        "id": 1129,
        "type": "DiscussionNote",
        "body": "reply to the discussion",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T13:38:02.127Z",
        "updated_at": "2018-03-04T13:38:02.127Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Merge request",
        "noteable_iid": null,
        "resolved": false,
        "resolvable": true,
        "resolved_by": null
      }
    ]
  },
  {
    "id": "87805b7c09016a7058e91bdbe7b29d1f284a39e6",
    "individual_note": true,
    "notes": [
      {
        "id": 1128,
        "type": null,
        "body": "a single comment",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T09:17:22.520Z",
        "updated_at": "2018-03-04T09:17:22.520Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Merge request",
        "noteable_iid": null,
        "resolved": false,
        "resolvable": true,
        "resolved_by": null
      }
    ]
  }
]

差异评论也包含位置信息：

[
  {
    "id": "87805b7c09016a7058e91bdbe7b29d1f284a39e6",
    "individual_note": false,
    "notes": [
      {
        "id": 1128,
        "type": "DiffNote",
        "body": "diff comment",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T09:17:22.520Z",
        "updated_at": "2018-03-04T09:17:22.520Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Merge request",
        "noteable_iid": null,
        "commit_id": "4803c71e6b1833ca72b8b26ef2ecd5adc8a38031",
        "position": {
          "base_sha": "b5d6e7b1613fca24d250fa8e5bc7bcc3dd6002ef",
          "start_sha": "7c9c2ead8a320fb7ba0b4e234bd9529a2614e306",
          "head_sha": "4803c71e6b1833ca72b8b26ef2ecd5adc8a38031",
          "old_path": "package.json",
          "new_path": "package.json",
          "position_type": "text",
          "old_line": 27,
          "new_line": 27,
          "line_range": {
            "start": {
              "line_code": "588440f66559714280628a4f9799f0c4eb880a4a_10_10",
              "type": "new"
            },
            "end": {
              "line_code": "588440f66559714280628a4f9799f0c4eb880a4a_11_11",
              "type": "old"
            }
          }
        },
        "resolved": false,
        "resolvable": true,
        "resolved_by": null
      }
    ]
  }
]

curl --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions"

获得合并请求的单个讨论

返回特定项目合并请求的单个讨论。

GET /projects/:id/merge_requests/:merge_request_iid/discussions/:discussion_id

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`merge_request_iid`	integer	yes	合并请求的 IID
`discussion_id`	integer	yes	讨论项的 ID

curl --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/<discussion_id>"

创建新的合并请求主题

commit id 引入于 13.7 版本。

为单个项目合并请求创建新主题。这类似于创建一个评论，不同的是可以在主题中添加新评论（回复）。

POST /projects/:id/merge_requests/:merge_request_iid/discussions

所有评论的参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`merge_request_iid`	integer	yes	合并请求的 IID
`body`	string	yes	主题的内容
`commit_id`	string	no	主题所在的提交的 SHA 值
`created_at`	string	no	日期时间字符串， ISO 8601 格式，如： `2016-03-11T03:45:40Z` （需要管理员或项目/组所有者的权限）
`position`	hash	no	创建差异评论的位置
`position[base_sha]`	string	yes	原分支提交的 SHA 值
`position[start_sha]`	string	yes	目标分支相关的提交的 SHA 值
`position[head_sha]`	string	yes	此合并请求的头部 SHA 值
`position[position_type]`	string	yes	位置引用的类型，允许的值为： `text` 或 `image`
`position[new_path]`	string	yes （如果位置引用类型是 `text`）	更改后的文件路径
`position[new_line]`	integer	no	变更后行号（对于 `text` 类型的差异评论)
`position[old_path]`	string	yes （如果位置引用类型是 `text`）	更改前的文件路径
`position[old_line]`	integer	no	变更前行号（对于 `text` 类型的差异评论）
`position[line_range]`	hash	no	多行差异评论的行范围
`position[width]`	integer	no	图像宽度（对于 `image` 类型的差异评论）
`position[height]`	integer	no	图像高度（对于 `image` 类型的差异评论）
`position[x]`	float	no	横坐标（对于 `image` 类型的差异评论）
`position[y]`	float	no	纵坐标（对于 `image` 类型的差异评论）

在概览页面上创建一个新主题

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions?body=comment"

在合并请求的差异中创建一个主题

position[old_path] 和 position[new_path] 都是必须的，必须引用更改之前和之后的文件路径。
要在添加的行上创建主题（在合并请求差异中以绿色突出显示），使用 position[new_line] 并且不要包含 position[old_line]。
要在删除的行上创建线程（在合并请求差异中以红色突出显示），使用 position[old_line] 并且不要包含 position[new_line]。
要在未修改的行上创建主题，需要包含 position[new_line] 和 position[old_line]。如果早期的修改改变了此文件的行号，这些位置信息可能会不一样。

创建一个新主题：

获取最新的合并请求版本：

curl --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/versions"

请注意最新版本的详细信息，它首先列出在响应数组中。

[
  {
    "id": 164560414,
    "head_commit_sha": "f9ce7e16e56c162edbc9e480108041cf6b0291fe",
    "base_commit_sha": "5e6dffa282c5129aa67cd227a0429be21bfdaf80",
    "start_commit_sha": "5e6dffa282c5129aa67cd227a0429be21bfdaf80",
    "created_at": "2021-03-30T09:18:27.351Z",
    "merge_request_id": 93958054,
    "state": "collected",
    "real_size": "2"
  },
  "previous versions are here"
]

创建一个新的差异主题，下面的例子在添加的行上创建一个新主题：

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>"\
  --form 'position[position_type]=text'\
  --form 'position[base_sha]=<use base_commit_sha from the versions response>'\
  --form 'position[head_sha]=<use head_commit_sha from the versions response>'\
  --form 'position[start_sha]=<use start_commit_sha from the versions response>'\
  --form 'position[new_path]=file.js'\
  --form 'position[old_path]=file.js'\
  --form 'position[new_line]=18'\
  --form 'body=test comment body'\
  "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions"

多行评论的参数

仅用于多行评论的参数：

参数	类型	是否必需	描述
`position[line_range][start]`	hash	no	多行评论的开始行号
`position[line_range][start][line_code]`	string	yes	起始行的行代码
`position[line_range][start][type]`	string	yes	这个提交添加的行使用 `new`，否则使用 `old`
`position[line_range][end]`	hash	no	多行评论的结束行号
`position[line_range][end][line_code]`	string	yes	结束行的行代码
`position[line_range][end][type]`	string	yes	这个提交添加的行使用 `new`，否则使用 `old`

行代码

行代码的形式是 <SHA>_<old>_<new>，像这样：adc83b19e793491b1c6ea0fd8b46cd9f32e292fc_5_5。

<SHA> 是文件名的 SHA1 哈希值。
<old> 是更改前的行号。
<new> 是更改后的行号。

例如，如果一个提交（<COMMIT_ID>）删除了自述文件中的第 463 行，您可以通过引用 old 文件中的第 463 行来发起删除行评论：

curl --request POST --header "PRIVATE-TOKEN: [ACCESS_TOKEN]"\
  --form "note=Very clever to remove this unnecessary line!"\
  --form "path=README" --form "line=463" --form "line_type=old"\
  "https://gitlab.com/api/v4/projects/47/repository/commits/<COMMIT_ID>/comments"

如果一个提交（<COMMIT_ID>）添加了第 157 行到 hello.rb，您可以通过引用 new 文件中的第 157 行来发起添加行评论：

curl --request POST --header "PRIVATE-TOKEN: [ACCESS_TOKEN]"\
  --form "note=This is brilliant!" --form "path=hello.rb"\
  --form "line=157" --form "line_type=new"\
  "https://gitlab.com/api/v4/projects/47/repository/commits/<COMMIT_ID>/comments"

解决合并请求中的主题

解决或取消解决合并请求中的讨论主题。

先决条件：

您必须至少拥有开发者的权限，或者是被评审的变更的作者。

PUT /projects/:id/merge_requests/:merge_request_iid/discussions/:discussion_id

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`merge_request_iid`	integer	yes	合并请求的 IID
`discussion_id`	integer	yes	主题的 ID
`resolved`	boolean	yes	解决或取消解决此讨论

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/<discussion_id>?resolved=true"

添加评论到现有合并请求的主题

为现有主题添加评论，也可以从一个评论创建一个主题。

POST /projects/:id/merge_requests/:merge_request_iid/discussions/:discussion_id/notes

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`merge_request_iid`	integer	yes	合并请求的 IID
`discussion_id`	integer	yes	主题的 ID
`note_id`	integer	yes	主题评论的 ID
`body`	string	yes	评论或回复的内容
`created_at`	string	no	日期时间字符串，ISO 8601 格式，如： `2016-03-11T03:45:40Z` （需要管理员或项目/组所有者的权限）

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/<discussion_id>/notes?body=comment"

修改现有合并请求主题中的评论

修改一个合并请求中已经存在的主题的评论。

PUT /projects/:id/merge_requests/:merge_request_iid/discussions/:discussion_id/notes/:note_id

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`merge_request_iid`	integer	yes	合并请求的 IID
`discussion_id`	integer	yes	主题的 ID
`note_id`	integer	yes	主题评论的 ID
`body`	string	no	评论或回复的内容（`body` 或 `resolved` 必须设置其中一个）
`resolved`	boolean	no	解决或取消解决此讨论（`body` 或 `resolved` 必须设置其中一个）

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/<discussion_id>/notes/1108?body=comment"

解决一个评论：

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/<discussion_id>/notes/1108?resolved=true"

删除一个合并请求主题的评论

删除一个合并请求中已经存在的主题的评论。

DELETE /projects/:id/merge_requests/:merge_request_iid/discussions/:discussion_id/notes/:note_id

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`merge_request_iid`	integer	yes	合并请求的 IID
`discussion_id`	integer	yes	主题的 ID
`note_id`	integer	yes	主题评论的 ID

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/636"

提交

项目提交主题列表

获取单个提交的所有主题列表。

GET /projects/:id/repository/commits/:commit_id/discussions

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`commit_id`	string	yes	提交的 SHA

[
  {
    "id": "6a9c1750b37d513a43987b574953fceb50b03ce7",
    "individual_note": false,
    "notes": [
      {
        "id": 1126,
        "type": "DiscussionNote",
        "body": "discussion text",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-03T21:54:39.668Z",
        "updated_at": "2018-03-03T21:54:39.668Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Commit",
        "noteable_iid": null,
        "resolvable": false
      },
      {
        "id": 1129,
        "type": "DiscussionNote",
        "body": "reply to the discussion",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T13:38:02.127Z",
        "updated_at": "2018-03-04T13:38:02.127Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Commit",
        "noteable_iid": null,
        "resolvable": false
      }
    ]
  },
  {
    "id": "87805b7c09016a7058e91bdbe7b29d1f284a39e6",
    "individual_note": true,
    "notes": [
      {
        "id": 1128,
        "type": null,
        "body": "a single comment",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T09:17:22.520Z",
        "updated_at": "2018-03-04T09:17:22.520Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Commit",
        "noteable_iid": null,
        "resolvable": false
      }
    ]
  }
]

差异评论也包含位置信息：

[
  {
    "id": "87805b7c09016a7058e91bdbe7b29d1f284a39e6",
    "individual_note": false,
    "notes": [
      {
        "id": 1128,
        "type": "DiffNote",
        "body": "diff comment",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T09:17:22.520Z",
        "updated_at": "2018-03-04T09:17:22.520Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Commit",
        "noteable_iid": null,
        "position": {
          "base_sha": "b5d6e7b1613fca24d250fa8e5bc7bcc3dd6002ef",
          "start_sha": "7c9c2ead8a320fb7ba0b4e234bd9529a2614e306",
          "head_sha": "4803c71e6b1833ca72b8b26ef2ecd5adc8a38031",
          "old_path": "package.json",
          "new_path": "package.json",
          "position_type": "text",
          "old_line": 27,
          "new_line": 27
        },
        "resolvable": false
      }
    ]
  }
]

curl --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/repository/commits/<commit_id>/discussions"

获得提交的单个讨论

返回特定项目提交的单个讨论。

GET /projects/:id/repository/commits/:commit_id/discussions/:discussion_id

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`commit_id`	string	yes	提交的 SHA
`discussion_id`	string	yes	讨论项的 ID

curl --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/repository/commits/<commit_id>/discussions/<discussion_id>"

创建新的提交主题

为单个项目提交创建新主题。这类似于创建一个评论，不同的是可以在主题中添加新评论（回复）。

POST /projects/:id/repository/commits/:commit_id/discussions

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`commit_id`	string	yes	提交的 SHA 值
`body`	string	yes	主题的内容
`created_at`	string	no	日期时间字符串， ISO 8601 格式，如： `2016-03-11T03:45:40Z` （需要管理员或项目/组所有者的权限）
`position`	hash	no	创建差异评论的位置
`position[base_sha]`	string	yes	父提交的 SHA 值
`position[start_sha]`	string	yes	父提交的 SHA 值
`position[head_sha]`	string	yes	此提交的 SHA 值（和 `commit_id` 一致）
`position[position_type]`	string	yes	位置引用的类型，允许的值为： `text` 或 `image`
`position[new_path]`	string	no	更改后的文件路径
`position[new_line]`	integer	no	变更后行号
`position[old_path]`	string	no	变更前的文件路径
`position[old_line]`	integer	no	变更前的行号
`position[width]`	integer	no	图像宽度（对于 `image` 类型的差异评论）
`position[height]`	integer	no	图像高度（对于 `image` 类型的差异评论）
`position[x]`	integer	no	横坐标（对于 `image` 类型的差异评论）
`position[y]`	integer	no	纵坐标（对于 `image` 类型的差异评论）

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/repository/commits/<commit_id>/discussions?body=comment"

除了 base_sha、 start_sha 和 head_sha 参数之外，创建 API 请求的规则与在合并请求中差异中创建主题的规则相同。

添加评论到现有提交的主题

为现有主题添加评论。

POST /projects/:id/repository/commits/:commit_id/discussions/:discussion_id/notes

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`commit_id`	string	yes	提交的 SHA
`discussion_id`	string	yes	主题的 ID
`note_id`	integer	yes	主题评论的 ID
`body`	string	yes	评论或回复的内容
`created_at`	string	no	日期时间字符串，ISO 8601 格式，如： `2016-03-11T03:45:40Z`（需要管理员或项目/组所有者的权限）

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/repository/commits/<commit_id>/discussions/<discussion_id>/notes?body=comment

修改现有提交主题中的评论

修改一个提交中已经存在的主题的评论。

PUT /projects/:id/repository/commits/:commit_id/discussions/:discussion_id/notes/:note_id

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`commit_id`	string	yes	提交的 SHA
`discussion_id`	string	yes	主题的 ID
`note_id`	integer	yes	主题评论的 ID
`body`	string	no	评论内容

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/repository/commits/<commit_id>/discussions/<discussion_id>/notes/1108?body=comment"

解决一个评论：

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/repository/commits/<commit_id>/discussions/<discussion_id>/notes/1108?resolved=true"

删除一个提交主题的评论

删除一个提交中已经存在的主题的评论。

DELETE /projects/:id/repository/commits/:commit_id/discussions/:discussion_id/notes/:note_id

参数：

参数	类型	是否必需	描述
`id`	integer/string	yes	项目的 ID 或 URL 编码的路径
`commit_id`	string	yes	提交的 SHA
`discussion_id`	string	yes	主题的 ID
`note_id`	integer	yes	主题评论的 ID

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>"\
  "https://gitlab.example.com/api/v4/projects/5/repository/commits/<commit_id>/discussions/<discussion_id>/notes/636"