githubPullRequest

Query

query GithubPullRequest($owner: String!, $name: String!, $number: Int!) {
  githubPullRequest(owner: $owner, name: $name, number: $number) {
    id
    codebaseRepositoryId
    number
    title
    url
    repositoryGithubId
  }
}

Variables

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

Response

{
  "data": {
    "githubPullRequest": {
      "id": "id",
      "codebaseRepositoryId": "id",
      "number": 1,
      "title": "string",
      "url": "string",
      "repositoryGithubId": "id"
    }
  }
}

QUERY

githubPullRequest(owner: String!, name: String!, number: Int!): GitHubPullRequestDetail

Arguments

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

GitHubPullRequestDetail

ID!

Stable identifier for this GitHub pull request detail.

codebaseRepositoryId

Identifier of the related codebase repository. May be null when unavailable or not applicable.

number

Int!

The number associated with this GitHub pull request detail.

title

String!

Human-readable title for this GitHub pull request detail.

url

String!

URL for this GitHub pull request detail.

repositoryGithubId

ID!

Identifier of the related repository GitHub.

repositoryNameWithOwner

String!

The repository name with owner associated with this GitHub pull request detail.

repositoryUrl

String!

URL for this GitHub pull request detail.

labels

[String!]!

Labels associated with this GitHub pull request detail.

jiraKey

String

The Jira key associated with this GitHub pull request detail. May be null when unavailable or not applicable.

pipelineStatus

GitHubPipelineStatus!

The pipeline status associated with this GitHub pull request detail.

pipelines

[GitHubPipeline!]!

Pipelines associated with this GitHub pull request detail.

pipelineRevision

Int!

The pipeline revision associated with this GitHub pull request detail.

reviewDecision

GitHubReviewDecision!

The review decision associated with this GitHub pull request detail.

unresolvedReviewThreadCount

Int!

Number of unresolved review threads.

createdAt

String!

ISO 8601 timestamp when this GitHub pull request detail was created.

body

String!

The body associated with this GitHub pull request detail.

bodyHtml

String!

The body html associated with this GitHub pull request detail.

author

GitHubPullRequestActor

The author associated with this GitHub pull request detail. May be null when unavailable or not applicable.

assignees

[GitHubPullRequestActor!]!

Assignees associated with this GitHub pull request detail.

reviewThreads

[GitHubReviewThread!]!

Review threads associated with this GitHub pull request detail.

baseRefName

String!

The base ref name associated with this GitHub pull request detail.

headRefName

String!

The head ref name associated with this GitHub pull request detail.

headRefOid

String!

The head ref oid associated with this GitHub pull request detail.

state

String!

Current state of this GitHub pull request detail.

isDraft

Boolean!

Whether this GitHub pull request detail is draft.

mergeable

String!

The mergeable associated with this GitHub pull request detail.

additions

Int!

The additions associated with this GitHub pull request detail.

deletions

Int!

The deletions associated with this GitHub pull request detail.

changedFiles

Int

The changed files associated with this GitHub pull request detail. May be null when unavailable or not applicable.

commitCount

Int!

Number of commits.

updatedAt

String!

ISO 8601 timestamp when this GitHub pull request detail was last updated.

mergedAt

String

ISO 8601 timestamp when this GitHub pull request detail merged. May be null when unavailable or not applicable.

worktreeId

Identifier of the related worktree. May be null when unavailable or not applicable.

worktreeHighlightColor

String

The worktree highlight color associated with this GitHub pull request detail. May be null when unavailable or not applicable.

Query

query GithubPullRequest($owner: String!, $name: String!, $number: Int!) {
  githubPullRequest(owner: $owner, name: $name, number: $number) {
    id
    codebaseRepositoryId
    number
    title
    url
    repositoryGithubId
  }
}

Variables

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

Response

{
  "data": {
    "githubPullRequest": {
      "id": "id",
      "codebaseRepositoryId": "id",
      "number": 1,
      "title": "string",
      "url": "string",
      "repositoryGithubId": "id"
    }
  }
}

Overview

Queries

Mutations

Types

Arguments

Returns