変更を提案 API

このページでは、変更を提案するための API について説明します。

提案へのAPI呼び出しはすべて認証されなければなりません。

提案の作成

API を使用して提案を作成するには、Discussions API を使用してマージリクエスト diff に新しいスレッドを作成してください。提案の書式は

```suggestion:-3+0
example text
```

提案の適用

マージリクエストで提案されたパッチを適用します。このアクションを実行するには、ユーザーは少なくとも開発者ロールを持っている必要があります。

PUT /suggestions/:id/apply
属性種類必須説明
id整数。yes提案のID
commit_message文字列です。いいえデフォルトの生成メッセージやプロジェクトのデフォルトメッセージの代わりに使うカスタムコミットメッセージ
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/suggestions/5/apply"

応答例

{
  "id": 5,
  "from_line": 10,
  "to_line": 10,
  "applicable": true,
  "applied": false,
  "from_content": "This is an eaxmple\n",
  "to_content": "This is an example\n"
}

複数の提案を適用 

PUT /suggestions/batch_apply
属性種類必須説明
ids整数。yes提案のID
commit_message文字列です。いいえデフォルトの生成メッセージやプロジェクトのデフォルトメッセージの代わりに使うカスタムコミットメッセージ
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --header 'Content-Type: application/json' --data '{"ids": [5, 6]}' "https://gitlab.example.com/api/v4/suggestions/batch_apply"

応答例

[
  {
    "id": 5,
    "from_line": 10,
    "to_line": 10,
    "applicable": true,
    "applied": false,
    "from_content": "This is an eaxmple\n",
    "to_content": "This is an example\n"
  }
  {
    "id": 6,
    "from_line": 19
    "to_line": 19,
    "applicable": true,
    "applied": false,
    "from_content": "This is another eaxmple\n",
    "to_content": "This is another example\n"
  }
 ]