ビジュアルレビューディスカッションAPI(非推奨)
この機能はGitLab 15.8で非推奨となり、17.0で削除される予定です。この変更はブレークチェンジです。
ビジュアルレビューのディスカッションは、ビジュアルレビューからのフィードバックとして送られたマージリクエストに関するメモです。
新しいマージリクエストスレッドの作成
一つのプロジェクトのマージリクエストに新しいスレッドを作成します。これはメモの作成と似ていますが、他のコメント(返信)を後から追加することができます。
POST /projects/:id/merge_requests/:merge_request_iid/visual_review_discussions
パラメータを指定します:
属性 | 種類 | 必須 | 説明 |
---|---|---|---|
id | 整数/文字列 | はい | プロジェクトのIDまたはURLエンコードされたパス |
merge_request_iid | 整数。 | はい | マージリクエストの IID |
body | 文字列です。 | はい | スレッドの内容 |
position | ハッシュ | なし | 差分ノート作成時の位置 |
position[base_sha] | 文字列です。 | はい | ソースブランチのベースコミットSHA |
position[start_sha] | 文字列です。 | はい | ターゲットブランチのコミットを参照する SHA |
position[head_sha] | 文字列です。 | はい | このマージリクエストのHEADを参照するSHA |
position[position_type] | 文字列です。 | はい | 位置参照のタイプ。text またはimage のいずれか。 |
position[new_path] | 文字列です。 | なし | 変更後のファイルパス |
position[new_line] | 整数。 | なし | 変更後の行番号(text の差分ノートにのみ保存されます。) |
position[old_path] | 文字列です。 | なし | 変更前のファイルパス |
position[old_line] | 整数。 | なし | 変更前の行番号(text の差分ノートにのみ保存されます。) |
position[width] | 整数。 | なし | 画像の横幅(image の差分ノートにのみ保存されます。) |
position[height] | 整数。 | なし | 画像の高さ(image の差分ノートにのみ保存されます。) |
position[x] | 整数。 | なし | X座標(image 差分ノートのみ保存) |
position[y] | 整数。 | なし | Y座標(image の差分ノートのみ保存されます。) |
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/visual_review_discussions?body=comment"