About objects
Objects in GraphQL represent the resources you can access. An object can contain a list of fields, which are specifically typed.
For example, the Repository object has a field called name, which is a String.
For more information, see "Introduction to GraphQL."
ActorLocation
Location information for an actor.
Fields
| Name | Description |
|---|---|
|
City. |
|
Country name. |
|
Country code. |
|
Region name. |
|
Region or state code. |
AddedToProjectEvent
Represents aadded_to_projectevent on a given issue or pull request.
Fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
Identifies the date and time when the object was created. |
|
Identifies the primary key from the database. |
|
Project referenced by event. Preview notice
|
|
Project card referenced by this project event. Preview notice
|
|
Column name referenced by this project event. Preview notice
|
App
A GitHub App.
Fields
| Name | Description |
|---|---|
|
Identifies the date and time when the object was created. |
|
Identifies the primary key from the database. |
|
The description of the app. |
|
The hex color code, without the leading '#', for the logo background. |
|
A URL pointing to the app's logo. Arguments
The size of the resulting image. |
|
The name of the app. |
|
A slug based on the name of the app for use in URLs. |
|
Identifies the date and time when the object was last updated. |
|
The URL to the app's homepage. |
AssignedEvent
Represents anassignedevent on any assignable object.
Fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
Identifies the assignable associated with the event. |
|
Identifies the user or mannequin that was assigned. |
|
Identifies the date and time when the object was created. |
|
Identifies the user who was assigned. Deprecation notice
Assignees can now be mannequins. Use the |
BaseRefChangedEvent
Represents abase_ref_changedevent on a given issue or pull request.
Fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
Identifies the date and time when the object was created. |
|
Identifies the primary key from the database. |
BaseRefForcePushedEvent
Represents abase_ref_force_pushedevent on a given pull request.
Fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
Identifies the after commit SHA for the |
|
Identifies the before commit SHA for the |
|
Identifies the date and time when the object was created. |
|
PullRequest referenced by event. |
|
Identifies the fully qualified ref name for the |
Blame
Represents a Git blame.
Fields
| Name | Description |
|---|---|
|
The list of ranges from a Git blame. |
BlameRange
Represents a range of information from a Git blame.
Fields
| Name | Description |
|---|---|
|
Identifies the recency of the change, from 1 (new) to 10 (old). This is calculated as a 2-quantile and determines the length of distance between the median age of all the changes in the file and the recency of the current range's change. |
|
Identifies the line author. |
|
The ending line for the range. |
|
The starting line for the range. |
Blob
Represents a Git blob.
Fields
| Name | Description |
|---|---|
|
An abbreviated version of the Git object ID. |
|
Byte size of Blob object. |
|
The HTTP path for this Git object. |
|
The HTTP URL for this Git object. |
|
Indicates whether the Blob is binary or text. |
|
Indicates whether the contents is truncated. |
|
The Git object ID. |
|
The Repository the Git object belongs to. |
|
UTF8 text data or null if the Blob is binary. |
Bot
A special type of user which takes actions on behalf of GitHub Apps.
Fields
| Name | Description |
|---|---|
|
A URL pointing to the GitHub App's public avatar. Arguments
The size of the resulting square image. |
|
Identifies the date and time when the object was created. |
|
Identifies the primary key from the database. |
|
The username of the actor. |
|
The HTTP path for this bot. |
|
Identifies the date and time when the object was last updated. |
|
The HTTP URL for this bot. |
BranchProtectionRule
A branch protection rule.
Fields
| Name | Description |
|---|---|
|
A list of conflicts matching branches protection rule and other branch protection rules. |
|
The actor who created this branch protection rule. |
|
Identifies the primary key from the database. |
|
Will new commits pushed to matching branches dismiss pull request review approvals. |
|
Can admins overwrite branch protection. |
|
Repository refs that are protected by this rule. |
|
Identifies the protection rule pattern. |
|
A list push allowances for this branch protection rule. |
|
The repository associated with this branch protection rule. |
|
Number of approving reviews required to update matching branches. |
|
List of required status check contexts that must pass for commits to be accepted to matching branches. |
|
Are approving reviews required to update matching branches. |
|
Are reviews from code owners required to update matching branches. |
|
Are commits required to be signed. |
|
Are status checks required to update matching branches. |
|
Are branches required to be up to date before merging. |
|
Is pushing to matching branches restricted. |
|
Is dismissal of pull request reviews restricted. |
|
A list review dismissal allowances for this branch protection rule. |
BranchProtectionRuleConflict
A conflict between two branch protection rules.
Fields
| Name | Description |
|---|---|
|
Identifies the branch protection rule. |
|
Identifies the conflicting branch protection rule. |
|
Identifies the branch ref that has conflicting rules. |
BranchProtectionRuleConflictConnection
The connection type for BranchProtectionRuleConflict.
Fields
| Name | Description |
|---|---|
A list of edges. |
|
|
A list of nodes. |
|
Information to aid in pagination. |
|
Identifies the total count of items in the connection. |
BranchProtectionRuleConflictEdge
An edge in a connection.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination. |
|
The item at the end of the edge. |
BranchProtectionRuleConnection
The connection type for BranchProtectionRule.
Fields
| Name | Description |
|---|---|
|
A list of edges. |
|
A list of nodes. |
|
Information to aid in pagination. |
|
Identifies the total count of items in the connection. |
BranchProtectionRuleEdge
An edge in a connection.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination. |
|
The item at the end of the edge. |
CheckAnnotation
A single check annotation.
Preview notice
CheckAnnotation is available under the Checks preview. During the preview period, the API may change without notice.
Fields
| Name | Description |
|---|---|
|
The annotation's severity level. |
|
The path to the file that this annotation was made on. |
|
Identifies the primary key from the database. |
|
The position of this annotation. |
|
The annotation's message. |
|
The path that this annotation was made on. |
|
Additional information about the annotation. |
|
The annotation's title. |
CheckAnnotationConnection
The connection type for CheckAnnotation.
Fields
| Name | Description |
|---|---|
|
A list of edges. |
|
A list of nodes. Preview notice
|
|
Information to aid in pagination. |
|
Identifies the total count of items in the connection. |
CheckAnnotationEdge
An edge in a connection.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination. |
|
The item at the end of the edge. Preview notice
|
CheckAnnotationPosition
A character position in a check annotation.
Preview notice
CheckAnnotationPosition is available under the Checks preview. During the preview period, the API may change without notice.
Fields
| Name | Description |
|---|---|
|
Column number (1 indexed). |
|
Line number (1 indexed). |