如何通过GitLab REST API让合并请求多行注释显示行范围提示？

目前GitLab REST API是支持生成带行范围提示的多行MR注释的，你遇到的问题大概率是请求体参数设置有误导致的，以下是具体分析和修正方案：

问题根源 #

你当前的请求体存在两个可能的问题：

1. 参数冲突：同时指定了new_line（单行注释参数）和line_range（多行注释参数），这会让GitLab无法正确识别你要注释的多行范围。
2. line_code不匹配：line_range中的line_code使用的commit SHA与position中的head_sha不一致，GitLab无法关联到正确的diff行。

修正后的请求体示例 #

移除冲突的new_line参数，并确保line_code中的commit SHA与head_sha保持一致（或使用MR对应的diff commit SHA）：

{
  "position": {
    "base_sha": "4af5230bd8894e9e56a5343537fd0f5dd1d3341b",
    "start_sha": "4af5230bd8894e9e56a5343537fd0f5dd1d3341b",
    "head_sha": "7e5df9ede4766b0c33509881055d00be94debdae",
    "new_path": "test.php",
    "old_path": "test.php",
    "position_type": "text",
    "line_range": {
      "start": {
        "line_code": "7e5df9ede4766b0c33509881055d00be94debdae_18_18",
        "type": "new"
      },
      "end": {
        "line_code": "7e5df9ede4766b0c33509881055d00be94debdae_18_20",
        "type": "new"
      }
    },
    "ignore_whitespace_change": false
  },
  "body": "test comment body"
}

额外注意事项 #

• 确认line_code中的行号与MR diff中的实际行号对应：line_code格式为<commit_sha>_<old_line>_<new_line>，当注释新添加的行时，old_line填0或对应旧文件的行号（如果是修改行）。
• 若修正后仍无行范围提示，检查GitLab版本：部分旧版本GitLab的API对多行注释的渲染支持不完善，建议升级到较新版本（14.0+版本已完善该功能）。

内容的提问来源于stack exchange，提问作者Thijs Janse