githubPullRequestMergeOptions

Query

query GithubPullRequestMergeOptions($source: GitHubRequestSource!, $owner: String!, $name: String!, $number: Int!) {
  githubPullRequestMergeOptions(source: $source, owner: $owner, name: $name, number: $number) {
    availableMethods
    commitEmails
    defaultCommitEmail
    defaultCommitHeadline
    defaultCommitBody
    canMerge
  }
}

Variables

{
  "source": "GITHUB_API",
  "owner": "string",
  "name": "string",
  "number": 1
}

Response

{
  "data": {
    "githubPullRequestMergeOptions": {
      "availableMethods": [
        "MERGE"
      ],
      "commitEmails": [
        "string"
      ],
      "defaultCommitEmail": "string",
      "defaultCommitHeadline": "string",
      "defaultCommitBody": "string",
      "canMerge": true
    }
  }
}

QUERY

githubPullRequestMergeOptions(source: GitHubRequestSource!, owner: String!, name: String!, number: Int!): GitHubPullRequestMergeOptions!

Arguments

source

GitHubRequestSource!

required

The source used to filter or perform the operation.

owner

String!

required

The owner used to filter or perform the operation.

name

String!

required

The name used to filter or perform the operation.

number

Int!

required

The number used to filter or perform the operation.

Returns

GitHubPullRequestMergeOptions!

availableMethods

[GitHubMergeMethod!]!

Available methods associated with this GitHub pull request merge options.

commitEmails

[String!]!

Commit emails associated with this GitHub pull request merge options.

defaultCommitEmail

String

The default commit email associated with this GitHub pull request merge options. May be null when unavailable or not applicable.

defaultCommitHeadline

String!

The default commit headline associated with this GitHub pull request merge options.

defaultCommitBody

String!

The default commit body associated with this GitHub pull request merge options.

canMerge

Boolean!

Whether this GitHub pull request merge options can merge.

canEnableAutoMerge

Boolean!

Whether this GitHub pull request merge options can enable auto merge.

autoMergeEnabled

Boolean!

Whether the auto merge enabled condition is true for this GitHub pull request merge options.

viewerCanDisableAutoMerge

Boolean!

Whether the viewer can disable auto merge condition is true for this GitHub pull request merge options.

mergeStateStatus

String!

The merge state status associated with this GitHub pull request merge options.

headRefOid

String!

The head ref oid associated with this GitHub pull request merge options.

blockedReason

String

The blocked reason associated with this GitHub pull request merge options. May be null when unavailable or not applicable.

Query

query GithubPullRequestMergeOptions($source: GitHubRequestSource!, $owner: String!, $name: String!, $number: Int!) {
  githubPullRequestMergeOptions(source: $source, owner: $owner, name: $name, number: $number) {
    availableMethods
    commitEmails
    defaultCommitEmail
    defaultCommitHeadline
    defaultCommitBody
    canMerge
  }
}

Variables

{
  "source": "GITHUB_API",
  "owner": "string",
  "name": "string",
  "number": 1
}

Response

{
  "data": {
    "githubPullRequestMergeOptions": {
      "availableMethods": [
        "MERGE"
      ],
      "commitEmails": [
        "string"
      ],
      "defaultCommitEmail": "string",
      "defaultCommitHeadline": "string",
      "defaultCommitBody": "string",
      "canMerge": true
    }
  }
}

Overview

Queries

Mutations

Types

Arguments

Returns