REST API の廃止と削除

v4 APIが廃止されると、以下のAPIが変更されます。

この変更の時期は不明です。詳細については、イシュー 216456およびイシュー 387485 を参照してください。

geo_nodes API エンドポイント

ブレークチェンジ関連イシュー

geo_nodes API エンドポイント は廃止され、geo_sitesに置き換えられました。これはGeo デプロイの参照方法に関するグローバルな変更の一部です。ノードの名前は、アプリケーション全体でサイトに変更されます。両方のエンドポイントの機能は変わりません。

merged_by API フィールド

ブレークチェンジ関連イシュー

マージリクエスト APIのmerged_by フィールドは廃止され、merge_user フィールドが使用されるようになりました。このフィールドは、単純なマージ以外のアクション (自動マージに設定、マージトレインに追加) を実行する際に、マージリクエストをマージしたユーザーをより正しく識別します。

API ユーザーは、代わりに新しいmerge_user フィールドを使用することをお勧めします。merged_by フィールドは GitLab REST API の v5 で削除される予定です。

merge_status API フィールド

ブレークチェンジ関連イシュー

マージリクエスト APIのmerge_status フィールドは廃止され、detailed_merge_status マージリクエストが持つ可能性のあるすべてのステータスをより正しく識別するフィールドが detailed_merge_status使用されるようになりました。detailed_merge_status API ユーザーは detailed_merge_status代わりにdetailed_merge_status 新しい detailed_merge_statusフィールドをdetailed_merge_status 使用することをお勧め detailed_merge_statusします。merge_status フィールドは GitLab REST API の v5 で削除される予定です。

ユーザー API のprivate_profile 属性の Null 値

ブレークチェンジ関連イシュー

API を通してユーザーを作成・更新する際、null はprivate_profile 属性の有効な値でしたが、内部的にデフォルト値に変換されていました。GitLab REST APIのv5では、null はこのパラメーターの有効な値ではなくなり、使用された場合のレスポンスは400になります。この変更後、有効な値はtrue とfalse のみとなります。

シングルマージリクエストのAPIエンドポイントの変更

ブレークチェンジ関連イシュー

単一のマージリクエストから変更を取得するエンドポイントは非推奨となり、マージリクエストの差分を一覧表示するエンドポイントが使用されるようになりました。API ユーザーは、代わりに新しい diffs エンドポイントに切り替えることを推奨します。

changes from a single merge request エンドポイントは GitLab REST API の v5 で削除される予定です。

マネージドライセンス API エンドポイント

ブレークチェンジ関連イシュー

指定されたプロジェクトのすべての管理対象ライセンスを取得するエンドポイントは廃止され、ライセンス承認ポリシー機能が使用されるようになりました。検出されたライセンスに基づいて引き続き承認を実施したいユーザーは、代わりに新しいライセンス承認ポリシーを作成することをお勧めします。

managed licenses エンドポイントは GitLab REST API の v5 で削除される予定です。

マージリクエスト承認 API の承認者と承認者グループフィールド

ブレークチェンジ関連イシュー

プロジェクトの承認者設定を取得するエンドポイントは、approvers とapproval_groups に対して空の配列を返します。これらのフィールドは、マージリクエストのプロジェクトレベルのルールを取得するエンドポイントを優先するため、非推奨となりました。API ユーザーは、代わりにこのエンドポイントに切り替えることをお勧めします。

これらのフィールドは GitLab REST API の v5 でget configuration エンドポイントから削除される予定です。

Runner の使用法active は次のように置き換えられます。paused

ブレークチェンジ関連イシュー

GitLab Runner GraphQL API エンドポイントのactive 識別子の出現は、GitLab 16.0 ではpaused にリネームされます。

  • GitLab 14.8 から始まる REST API の v4 では、paused プロパティの代わりにactive
  • REST API v5 では、この変更はactive プロパティを受け取ったり返したりするエンドポイントに影響します：
    • GET /runners
    • GET /runners/all
    • GET /runners/:id /PUT /runners/:id
    • PUT --form "active=false" /runners/:runner_id
    • GET /projects/:id/runners /POST /projects/:id/runners
    • GET /groups/:id/runners

GitLab Runnerの16.0リリースでは、Runnerを登録する際にpaused プロパティを使用するようになります。

ランナーのステータスはpaused

ブレークチェンジ関連イシュー

REST API の将来の v5 では、GitLab Runner のエンドポイントはpaused またはactive を返しません。

ランナーのステータスは、ランナーのコンタクトステータスのみに関連します：online offline not_connectedステータスpaused やactive は表示されなくなります。

pausedAPI ユーザーは paused、ランナーがtrue であるかどうかをチェックすpausedる場合、代 pausedわりに boolean 属性が であるかどうかをpausedチェックすることをお勧め pausedします。ランナーがactive であるかどうかをチェックする場合は、paused がfalse であるかどうかをチェックしてください。

ランナーはip_address

ブレークチェンジ関連イシュー

GitLab 17.0 では、Runners APIはランナーのip_address の代わりに"" を返します。REST API の v5 では、このフィールドは削除されます。