merge_queue

Preview the impact of dequeuing a pull request

Changed on

Return how many batches would be interrupted, how many other pull requests would be rechecked, and how many stacked pull requests would also be dequeued if the given pull request is manually dequeued

get/repos/{owner}/{repository}/merge-queue/pull/{pr_number}/dequeue-impact

Request

  • Base URL: https://api.mergify.com/v1
  • URL: https://api.mergify.com/v1/repos/{owner}/{repository}/merge-queue/pull/{pr_number}/dequeue-impact
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

pr_numberinteger required

The pull request number

repositorystring required

The name of the repository

ownerstring required

The owner of the repository

Response

Successful Response

interrupted_batchesinteger required

Number of in-progress batches whose checks would be interrupted and restarted if this pull request is dequeued

rechecked_pull_requestsinteger required

Number of other pull requests from the interrupted batches that would be re-embarked and rechecked

cascaded_pull_requestsinteger required

Number of queued pull requests stacked on top of this one that would also be dequeued (excludes the dequeued pull request itself)

Changes

  • f0fe01773ba8Revision changes
    • warning

      added the new TEST_STATE_OVERLAP enum value to the response property for the response status

  • 24834a2d3673Revision changes
    • info

      removed the REPOSITORY_NOT_RECORDED enum value from the response property for the response status