수표

Checks 범주의 GraphQL 스키마 형식에 대한 참조 설명서입니다.

이 기사에서

Mutations

createCheckRun

Mutation

Create a check run.

createCheckRun에 대한 입력 필드

createCheckRun에 대한 반환 필드

이름설명

checkRun (CheckRun)

The newly created check run.

clientMutationId (String)

A unique identifier for the client performing the mutation.

createCheckSuite

Mutation

Create a check suite.

createCheckSuite에 대한 입력 필드

createCheckSuite에 대한 반환 필드

이름설명

checkSuite (CheckSuite)

The newly created check suite.

clientMutationId (String)

A unique identifier for the client performing the mutation.

rerequestCheckSuite

Mutation

Rerequests an existing check suite.

rerequestCheckSuite에 대한 입력 필드

rerequestCheckSuite에 대한 반환 필드

이름설명

checkSuite (CheckSuite)

The requested check suite.

clientMutationId (String)

A unique identifier for the client performing the mutation.

updateCheckRun

Mutation

Update a check run.

updateCheckRun에 대한 입력 필드

updateCheckRun에 대한 반환 필드

이름설명

checkRun (CheckRun)

The updated check run.

clientMutationId (String)

A unique identifier for the client performing the mutation.

updateCheckSuitePreferences

Mutation

Modifies the settings of an existing check suite.

updateCheckSuitePreferences에 대한 입력 필드

updateCheckSuitePreferences에 대한 반환 필드

이름설명

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The updated repository.

Objects

CheckAnnotation

Object

A single check annotation.

CheckAnnotation에 대한 필드

이름설명

annotationLevel (CheckAnnotationLevel)

The annotation's severity level.

blobUrl (URI!)

The path to the file that this annotation was made on.

databaseId (Int)

Identifies the primary key from the database.

경고

databaseId is deprecated.

databaseId will be removed because it does not support 64-bit signed integer identifiers. Use fullDatabaseId instead. Removal on 2027-01-01 UTC.

fullDatabaseId (BigInt)

Identifies the primary key from the database as a BigInt.

location (CheckAnnotationSpan!)

The position of this annotation.

message (String!)

The annotation's message.

path (String!)

The path that this annotation was made on.

rawDetails (String)

Additional information about the annotation.

title (String)

The annotation's title.

CheckAnnotationConnection

Object

The connection type for CheckAnnotation.

CheckAnnotationConnection에 대한 필드

이름설명

edges ([CheckAnnotationEdge])

A list of edges.

nodes ([CheckAnnotation])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CheckAnnotationEdge

Object

An edge in a connection.

CheckAnnotationEdge에 대한 필드

이름설명

cursor (String!)

A cursor for use in pagination.

node (CheckAnnotation)

The item at the end of the edge.

CheckAnnotationPosition

Object

A character position in a check annotation.

CheckAnnotationPosition에 대한 필드

이름설명

column (Int)

Column number (1 indexed).

line (Int!)

Line number (1 indexed).

CheckAnnotationSpan

Object

An inclusive pair of positions for a check annotation.

CheckAnnotationSpan에 대한 필드

이름설명

end (CheckAnnotationPosition!)

End position (inclusive).

start (CheckAnnotationPosition!)

Start position (inclusive).

CheckRun

Object

A check run.

CheckRun 구현

CheckRun에 대한 필드

이름설명

annotations (CheckAnnotationConnection)

The check run's annotations.

annotations 의 인수

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

checkSuite (CheckSuite!)

The check suite that this run is a part of.

completedAt (DateTime)

Identifies the date and time when the check run was completed.

conclusion (CheckConclusionState)

The conclusion of the check run.

databaseId (Int)

Identifies the primary key from the database.

deployment (Deployment)

The corresponding deployment for this job, if any.

detailsUrl (URI)

The URL from which to find full details of the check run on the integrator's site.

externalId (String)

A reference for the check run on the integrator's system.

id (ID!)

The Node ID of the CheckRun object.

isRequired (Boolean!)

Whether this is required to pass before merging for a specific pull request.

isRequired 의 인수

  • pullRequestId (ID)

    The id of the pull request this is required for.

  • pullRequestNumber (Int)

    The number of the pull request this is required for.

name (String!)

The name of the check for this check run.

pendingDeploymentRequest (DeploymentRequest)

Information about a pending deployment, if any, in this check run.

permalink (URI!)

The permalink to the check run summary.

repository (Repository!)

The repository associated with this check run.

resourcePath (URI!)

The HTTP path for this check run.

startedAt (DateTime)

Identifies the date and time when the check run was started.

status (CheckStatusState!)

The current status of the check run.

steps (CheckStepConnection)

The check run's steps.

steps 의 인수

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

  • number (Int)

    Step number.

summary (String)

A string representing the check run's summary.

text (String)

A string representing the check run's text.

title (String)

A string representing the check run.

url (URI!)

The HTTP URL for this check run.

CheckRunConnection

Object

The connection type for CheckRun.

CheckRunConnection에 대한 필드

이름설명

edges ([CheckRunEdge])

A list of edges.

nodes ([CheckRun])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CheckRunEdge

Object

An edge in a connection.

CheckRunEdge에 대한 필드

이름설명

cursor (String!)

A cursor for use in pagination.

node (CheckRun)

The item at the end of the edge.

CheckRunStateCount

Object

Represents a count of the state of a check run.

CheckRunStateCount에 대한 필드

이름설명

count (Int!)

The number of check runs with this state.

state (CheckRunState!)

The state of a check run.

CheckStep

Object

A single check step.

CheckStep에 대한 필드

이름설명

completedAt (DateTime)

Identifies the date and time when the check step was completed.

conclusion (CheckConclusionState)

The conclusion of the check step.

externalId (String)

A reference for the check step on the integrator's system.

name (String!)

The step's name.

number (Int!)

The index of the step in the list of steps of the parent check run.

secondsToCompletion (Int)

Number of seconds to completion.

startedAt (DateTime)

Identifies the date and time when the check step was started.

status (CheckStatusState!)

The current status of the check step.

CheckStepConnection

Object

The connection type for CheckStep.

CheckStepConnection에 대한 필드

이름설명

edges ([CheckStepEdge])

A list of edges.

nodes ([CheckStep])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

CheckStepEdge

Object

An edge in a connection.

CheckStepEdge에 대한 필드

이름설명

cursor (String!)

A cursor for use in pagination.

node (CheckStep)

The item at the end of the edge.

CheckSuite

Object

A check suite.

CheckSuite 구현

CheckSuite에 대한 필드

이름설명

app (App)

The GitHub App which created this check suite.

branch (Ref)

The name of the branch for this check suite.

checkRuns (CheckRunConnection)

The check runs associated with a check suite.

checkRuns 의 인수

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

commit (Commit!)

The commit for this check suite.

conclusion (CheckConclusionState)

The conclusion of this check suite.

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (User)

The user who triggered the check suite.

databaseId (Int)