检查

“检查”类别中 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.