メモ
この機能はパブリック プレビュー段階であり、変更される可能性があります。
GitHub REST API と GraphQL API の両方で、スタックされたプル要求が公開されます。 REST API はスタックの読み取りと管理をサポートし、GraphQL API は読み取り専用クエリをサポートします。
API を使用して、プル要求のスタック メンバーシップを読み取るか、スタックされたプル要求の独自の自動化と統合を構築します。
REST API
REST API は、次の 2 つの方法でスタックプル要求を公開します。
- pull request リソースの
stackオブジェクト。 プル要求がスタックに属している場合、その REST リソースにはstackオブジェクトが含まれます。 これにより、プル要求から直接、プル要求のスタック メンバーシップ (スタックの数とサイズ、プル要求の位置とベースなど) を読み取ります。 - Stacks API。 スタックの一覧表示、読み取り、作成、拡張、およびディゾルブを行う専用のエンドポイント セット。 これは、スタックを作成および変更するためのサーフェスです。
メモ
API を使用してマージし、スタックされたプル要求を使用する場合は、スタックに新しいマージ API を使用するようにコードを更新する必要があります。 「Pull request 用 REST API エンドポイント」を参照してください。
エンドポイント、パラメーター、およびスキーマについては、 Pull request 用 REST API エンドポイント を参照してください。
GraphQL API
GraphQL API は、stack型の読み取り専用のstackEntryフィールドとPullRequest フィールドを使用して、プル要求のスタック メンバーシップを公開します。 これらのフィールドを使用して、プル要求が属するスタックとその中の位置を照会します。
GraphQL API はスタックの読み取り専用です。スタックの変異はありません。 スタックを作成または変更するには、REST API を使用します。
フィールド、オブジェクト、およびスキーマについては、 Pull Request を参照してください。