{"meta":{"title":"수표","intro":"Checks 범주의 GraphQL 스키마 형식에 대한 참조 설명서입니다.","product":"GraphQL API","breadcrumbs":[{"href":"/ko/enterprise-cloud@latest/graphql","title":"GraphQL API"},{"href":"/ko/enterprise-cloud@latest/graphql/reference","title":"참조"},{"href":"/ko/enterprise-cloud@latest/graphql/reference/checks","title":"수표"}],"documentType":"article"},"body":"# 수표\n\nChecks 범주의 GraphQL 스키마 형식에 대한 참조 설명서입니다.\n\n## CheckAnnotation - object\n\nA single check annotation.\n\n### Fields for `CheckAnnotation`\n\n* `annotationLevel` (CheckAnnotationLevel): The annotation's severity level.\n* `blobUrl` (URI!): The path to the file that this annotation was made on.\n* `databaseId` (Int): Identifies the primary key from the database. **Deprecated:** databaseId will be removed because it does not support 64-bit signed integer identifiers. Use fullDatabaseId instead. Removal on 2027-01-01 UTC.\n* `fullDatabaseId` (BigInt): Identifies the primary key from the database as a BigInt.\n* `location` (CheckAnnotationSpan!): The position of this annotation.\n* `message` (String!): The annotation's message.\n* `path` (String!): The path that this annotation was made on.\n* `rawDetails` (String): Additional information about the annotation.\n* `title` (String): The annotation's title.\n\n## CheckAnnotationConnection - object\n\nThe connection type for CheckAnnotation.\n\n### Fields for `CheckAnnotationConnection`\n\n* `edges` ([CheckAnnotationEdge]): A list of edges.\n* `nodes` ([CheckAnnotation]): A list of nodes.\n* `pageInfo` (PageInfo!): Information to aid in pagination.\n* `totalCount` (Int!): Identifies the total count of items in the connection.\n\n## CheckAnnotationData - input object\n\nInformation from a check run analysis to specific lines of code.\n\n### Input fields for `CheckAnnotationData`\n\n* `annotationLevel` (CheckAnnotationLevel!): Represents an annotation's information level.\n* `location` (CheckAnnotationRange!): The location of the annotation.\n* `message` (String!): A short description of the feedback for these lines of code.\n* `path` (String!): The path of the file to add an annotation to.\n* `rawDetails` (String): Details about this annotation.\n* `title` (String): The title that represents the annotation.\n\n## CheckAnnotationEdge - object\n\nAn edge in a connection.\n\n### Fields for `CheckAnnotationEdge`\n\n* `cursor` (String!): A cursor for use in pagination.\n* `node` (CheckAnnotation): The item at the end of the edge.\n\n## CheckAnnotationLevel - enum\n\nRepresents an annotation's information level.\n\n### Values for `CheckAnnotationLevel`\n\n* `FAILURE`: An annotation indicating an inescapable error.\n* `NOTICE`: An annotation indicating some information.\n* `WARNING`: An annotation indicating an ignorable error.\n\n## CheckAnnotationPosition - object\n\nA character position in a check annotation.\n\n### Fields for `CheckAnnotationPosition`\n\n* `column` (Int): Column number (1 indexed).\n* `line` (Int!): Line number (1 indexed).\n\n## CheckAnnotationRange - input object\n\nInformation from a check run analysis to specific lines of code.\n\n### Input fields for `CheckAnnotationRange`\n\n* `endColumn` (Int): The ending column of the range.\n* `endLine` (Int!): The ending line of the range.\n* `startColumn` (Int): The starting column of the range.\n* `startLine` (Int!): The starting line of the range.\n\n## CheckAnnotationSpan - object\n\nAn inclusive pair of positions for a check annotation.\n\n### Fields for `CheckAnnotationSpan`\n\n* `end` (CheckAnnotationPosition!): End position (inclusive).\n* `start` (CheckAnnotationPosition!): Start position (inclusive).\n\n## CheckConclusionState - enum\n\nThe possible states for a check suite or run conclusion.\n\n### Values for `CheckConclusionState`\n\n* `ACTION_REQUIRED`: The check suite or run requires action.\n* `CANCELLED`: The check suite or run has been cancelled.\n* `FAILURE`: The check suite or run has failed.\n* `NEUTRAL`: The check suite or run was neutral.\n* `SKIPPED`: The check suite or run was skipped.\n* `STALE`: The check suite or run was marked stale by GitHub. Only GitHub can use this conclusion.\n* `STARTUP_FAILURE`: The check suite or run has failed at startup.\n* `SUCCESS`: The check suite or run has succeeded.\n* `TIMED_OUT`: The check suite or run has timed out.\n\n## CheckRun - object\n\nA check run.\n\n**Implements:** Node, RequirableByPullRequest, UniformResourceLocatable\n\n### Fields for `CheckRun`\n\n* `annotations` (CheckAnnotationConnection): The check run's annotations. _(Pagination: `after`, `before`, `first`, `last`)_\n* `checkSuite` (CheckSuite!): The check suite that this run is a part of.\n* `completedAt` (DateTime): Identifies the date and time when the check run was completed.\n* `conclusion` (CheckConclusionState): The conclusion of the check run.\n* `databaseId` (Int): Identifies the primary key from the database.\n* `deployment` (Deployment): The corresponding deployment for this job, if any.\n* `detailsUrl` (URI): The URL from which to find full details of the check run on the integrator's site.\n* `externalId` (String): A reference for the check run on the integrator's system.\n* `id` (ID!): The Node ID of the CheckRun object.\n* `isRequired` (Boolean!): Whether this is required to pass before merging for a specific pull request.\n  * `pullRequestId` (ID): The id of the pull request this is required for.\n  * `pullRequestNumber` (Int): The number of the pull request this is required for.\n\n* `name` (String!): The name of the check for this check run.\n* `pendingDeploymentRequest` (DeploymentRequest): Information about a pending deployment, if any, in this check run.\n* `permalink` (URI!): The permalink to the check run summary.\n* `repository` (Repository!): The repository associated with this check run.\n* `resourcePath` (URI!): The HTTP path for this check run.\n* `startedAt` (DateTime): Identifies the date and time when the check run was started.\n* `status` (CheckStatusState!): The current status of the check run.\n* `steps` (CheckStepConnection): The check run's steps.\n  * `after` (String): Returns the elements in the list that come after the specified cursor.\n  * `before` (String): Returns the elements in the list that come before the specified cursor.\n  * `first` (Int): Returns the first n elements from the list.\n  * `last` (Int): Returns the last n elements from the list.\n  * `number` (Int): Step number.\n\n* `summary` (String): A string representing the check run's summary.\n* `text` (String): A string representing the check run's text.\n* `title` (String): A string representing the check run.\n* `url` (URI!): The HTTP URL for this check run.\n\n## CheckRunAction - input object\n\nPossible further actions the integrator can perform.\n\n### Input fields for `CheckRunAction`\n\n* `description` (String!): A short explanation of what this action would do.\n* `identifier` (String!): A reference for the action on the integrator's system.\n* `label` (String!): The text to be displayed on a button in the web UI.\n\n## CheckRunConnection - object\n\nThe connection type for CheckRun.\n\n### Fields for `CheckRunConnection`\n\n* `edges` ([CheckRunEdge]): A list of edges.\n* `nodes` ([CheckRun]): A list of nodes.\n* `pageInfo` (PageInfo!): Information to aid in pagination.\n* `totalCount` (Int!): Identifies the total count of items in the connection.\n\n## CheckRunEdge - object\n\nAn edge in a connection.\n\n### Fields for `CheckRunEdge`\n\n* `cursor` (String!): A cursor for use in pagination.\n* `node` (CheckRun): The item at the end of the edge.\n\n## CheckRunFilter - input object\n\nThe filters that are available when fetching check runs.\n\n### Input fields for `CheckRunFilter`\n\n* `appId` (Int): Filters the check runs created by this application ID.\n* `checkName` (String): Filters the check runs by this name.\n* `checkType` (CheckRunType): Filters the check runs by this type.\n* `conclusions` ([CheckConclusionState!]): Filters the check runs by these conclusions.\n* `status` (CheckStatusState): Filters the check runs by this status. Superceded by statuses.\n* `statuses` ([CheckStatusState!]): Filters the check runs by this status. Overrides status.\n\n## CheckRunOutput - input object\n\nDescriptive details about the check run.\n\n### Input fields for `CheckRunOutput`\n\n* `annotations` ([CheckAnnotationData!]): The annotations that are made as part of the check run.\n* `images` ([CheckRunOutputImage!]): Images attached to the check run output displayed in the GitHub pull request UI.\n* `summary` (String!): The summary of the check run (supports Commonmark).\n* `text` (String): The details of the check run (supports Commonmark).\n* `title` (String!): A title to provide for this check run.\n\n## CheckRunOutputImage - input object\n\nImages attached to the check run output displayed in the GitHub pull request UI.\n\n### Input fields for `CheckRunOutputImage`\n\n* `alt` (String!): The alternative text for the image.\n* `caption` (String): A short image description.\n* `imageUrl` (URI!): The full URL of the image.\n\n## CheckRunState - enum\n\nThe possible states of a check run in a status rollup.\n\n### Values for `CheckRunState`\n\n* `ACTION_REQUIRED`: The check run requires action.\n* `CANCELLED`: The check run has been cancelled.\n* `COMPLETED`: The check run has been completed.\n* `FAILURE`: The check run has failed.\n* `IN_PROGRESS`: The check run is in progress.\n* `NEUTRAL`: The check run was neutral.\n* `PENDING`: The check run is in pending state.\n* `QUEUED`: The check run has been queued.\n* `SKIPPED`: The check run was skipped.\n* `STALE`: The check run was marked stale by GitHub. Only GitHub can use this conclusion.\n* `STARTUP_FAILURE`: The check run has failed at startup.\n* `SUCCESS`: The check run has succeeded.\n* `TIMED_OUT`: The check run has timed out.\n* `WAITING`: The check run is in waiting state.\n\n## CheckRunStateCount - object\n\nRepresents a count of the state of a check run.\n\n### Fields for `CheckRunStateCount`\n\n* `count` (Int!): The number of check runs with this state.\n* `state` (CheckRunState!): The state of a check run.\n\n## CheckRunType - enum\n\nThe possible types of check runs.\n\n### Values for `CheckRunType`\n\n* `ALL`: Every check run available.\n* `LATEST`: The latest check run.\n\n## CheckStatusState - enum\n\nThe possible states for a check suite or run status.\n\n### Values for `CheckStatusState`\n\n* `COMPLETED`: The check suite or run has been completed.\n* `IN_PROGRESS`: The check suite or run is in progress.\n* `PENDING`: The check suite or run is in pending state.\n* `QUEUED`: The check suite or run has been queued.\n* `REQUESTED`: The check suite or run has been requested.\n* `WAITING`: The check suite or run is in waiting state.\n\n## CheckStep - object\n\nA single check step.\n\n### Fields for `CheckStep`\n\n* `completedAt` (DateTime): Identifies the date and time when the check step was completed.\n* `conclusion` (CheckConclusionState): The conclusion of the check step.\n* `externalId` (String): A reference for the check step on the integrator's system.\n* `name` (String!): The step's name.\n* `number` (Int!): The index of the step in the list of steps of the parent check run.\n* `secondsToCompletion` (Int): Number of seconds to completion.\n* `startedAt` (DateTime): Identifies the date and time when the check step was started.\n* `status` (CheckStatusState!): The current status of the check step.\n\n## CheckStepConnection - object\n\nThe connection type for CheckStep.\n\n### Fields for `CheckStepConnection`\n\n* `edges` ([CheckStepEdge]): A list of edges.\n* `nodes` ([CheckStep]): A list of nodes.\n* `pageInfo` (PageInfo!): Information to aid in pagination.\n* `totalCount` (Int!): Identifies the total count of items in the connection.\n\n## CheckStepEdge - object\n\nAn edge in a connection.\n\n### Fields for `CheckStepEdge`\n\n* `cursor` (String!): A cursor for use in pagination.\n* `node` (CheckStep): The item at the end of the edge.\n\n## CheckSuite - object\n\nA check suite.\n\n**Implements:** Node\n\n### Fields for `CheckSuite`\n\n* `app` (App): The GitHub App which created this check suite.\n* `branch` (Ref): The name of the branch for this check suite.\n* `checkRuns` (CheckRunConnection): The check runs associated with a check suite.\n  * `after` (String): Returns the elements in the list that come after the specified cursor.\n  * `before` (String): Returns the elements in the list that come before the specified cursor.\n  * `filterBy` (CheckRunFilter): Filters the check runs by this type.\n  * `first` (Int): Returns the first n elements from the list.\n  * `last` (Int): Returns the last n elements from the list.\n\n* `commit` (Commit!): The commit for this check suite.\n* `conclusion` (CheckConclusionState): The conclusion of this check suite.\n* `createdAt` (DateTime!): Identifies the date and time when the object was created.\n* `creator` (User): The user who triggered the check suite.\n* `databaseId` (Int): Identifies the primary key from the database.\n* `id` (ID!): The Node ID of the CheckSuite object.\n* `matchingPullRequests` (PullRequestConnection): A list of open pull requests matching the check suite.\n  * `after` (String): Returns the elements in the list that come after the specified cursor.\n  * `baseRefName` (String): The base ref name to filter the pull requests by.\n  * `before` (String): Returns the elements in the list that come before the specified cursor.\n  * `first` (Int): Returns the first n elements from the list.\n  * `headRefName` (String): The head ref name to filter the pull requests by.\n  * `labels` ([String!]): A list of label names to filter the pull requests by.\n  * `last` (Int): Returns the last n elements from the list.\n  * `orderBy` (IssueOrder): Ordering options for pull requests returned from the connection.\n  * `states` ([PullRequestState!]): A list of states to filter the pull requests by.\n\n* `push` (Push): The push that triggered this check suite.\n* `repository` (Repository!): The repository associated with this check suite.\n* `resourcePath` (URI!): The HTTP path for this check suite.\n* `status` (CheckStatusState!): The status of this check suite.\n* `updatedAt` (DateTime!): Identifies the date and time when the object was last updated.\n* `url` (URI!): The HTTP URL for this check suite.\n* `workflowRun` (WorkflowRun): The workflow run associated with this check suite.\n\n## CheckSuiteAutoTriggerPreference - input object\n\nThe auto-trigger preferences that are available for check suites.\n\n### Input fields for `CheckSuiteAutoTriggerPreference`\n\n* `appId` (ID!): The node ID of the application that owns the check suite.\n* `setting` (Boolean!): Set to true to enable automatic creation of CheckSuite events upon pushes to the repository.\n\n## CheckSuiteConnection - object\n\nThe connection type for CheckSuite.\n\n### Fields for `CheckSuiteConnection`\n\n* `edges` ([CheckSuiteEdge]): A list of edges.\n* `nodes` ([CheckSuite]): A list of nodes.\n* `pageInfo` (PageInfo!): Information to aid in pagination.\n* `totalCount` (Int!): Identifies the total count of items in the connection.\n\n## CheckSuiteEdge - object\n\nAn edge in a connection.\n\n### Fields for `CheckSuiteEdge`\n\n* `cursor` (String!): A cursor for use in pagination.\n* `node` (CheckSuite): The item at the end of the edge.\n\n## CheckSuiteFilter - input object\n\nThe filters that are available when fetching check suites.\n\n### Input fields for `CheckSuiteFilter`\n\n* `appId` (Int): Filters the check suites created by this application ID.\n* `checkName` (String): Filters the check suites by this name.\n\n## createCheckRun - mutation\n\nCreate a check run.\n\n### Input fields for `createCheckRun`\n\n* `input` (CreateCheckRunInput!): \n\n### Return fields for `createCheckRun`\n\n* `checkRun` (CheckRun): The newly created check run.\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n\n## CreateCheckRunInput - input object\n\nAutogenerated input type of CreateCheckRun.\n\n### Input fields for `CreateCheckRunInput`\n\n* `actions` ([CheckRunAction!]): Possible further actions the integrator can perform, which a user may trigger.\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `completedAt` (DateTime): The time that the check run finished.\n* `conclusion` (CheckConclusionState): The final conclusion of the check.\n* `detailsUrl` (URI): The URL of the integrator's site that has the full details of the check.\n* `externalId` (String): A reference for the run on the integrator's system.\n* `headSha` (GitObjectID!): The SHA of the head commit.\n* `name` (String!): The name of the check.\n* `output` (CheckRunOutput): Descriptive details about the run.\n* `repositoryId` (ID!): The node ID of the repository.\n* `startedAt` (DateTime): The time that the check run began.\n* `status` (RequestableCheckStatusState): The current status.\n\n## createCheckSuite - mutation\n\nCreate a check suite.\n\n### Input fields for `createCheckSuite`\n\n* `input` (CreateCheckSuiteInput!): \n\n### Return fields for `createCheckSuite`\n\n* `checkSuite` (CheckSuite): The newly created check suite.\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n\n## CreateCheckSuiteInput - input object\n\nAutogenerated input type of CreateCheckSuite.\n\n### Input fields for `CreateCheckSuiteInput`\n\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `headSha` (GitObjectID!): The SHA of the head commit.\n* `repositoryId` (ID!): The Node ID of the repository.\n\n## RequestableCheckStatusState - enum\n\nThe possible states that can be requested when creating a check run.\n\n### Values for `RequestableCheckStatusState`\n\n* `COMPLETED`: The check suite or run has been completed.\n* `IN_PROGRESS`: The check suite or run is in progress.\n* `PENDING`: The check suite or run is in pending state.\n* `QUEUED`: The check suite or run has been queued.\n* `WAITING`: The check suite or run is in waiting state.\n\n## rerequestCheckSuite - mutation\n\nRerequests an existing check suite.\n\n### Input fields for `rerequestCheckSuite`\n\n* `input` (RerequestCheckSuiteInput!): \n\n### Return fields for `rerequestCheckSuite`\n\n* `checkSuite` (CheckSuite): The requested check suite.\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n\n## RerequestCheckSuiteInput - input object\n\nAutogenerated input type of RerequestCheckSuite.\n\n### Input fields for `RerequestCheckSuiteInput`\n\n* `checkSuiteId` (ID!): The Node ID of the check suite.\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `repositoryId` (ID!): The Node ID of the repository.\n\n## updateCheckRun - mutation\n\nUpdate a check run.\n\n### Input fields for `updateCheckRun`\n\n* `input` (UpdateCheckRunInput!): \n\n### Return fields for `updateCheckRun`\n\n* `checkRun` (CheckRun): The updated check run.\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n\n## UpdateCheckRunInput - input object\n\nAutogenerated input type of UpdateCheckRun.\n\n### Input fields for `UpdateCheckRunInput`\n\n* `actions` ([CheckRunAction!]): Possible further actions the integrator can perform, which a user may trigger.\n* `checkRunId` (ID!): The node of the check.\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `completedAt` (DateTime): The time that the check run finished.\n* `conclusion` (CheckConclusionState): The final conclusion of the check.\n* `detailsUrl` (URI): The URL of the integrator's site that has the full details of the check.\n* `externalId` (String): A reference for the run on the integrator's system.\n* `name` (String): The name of the check.\n* `output` (CheckRunOutput): Descriptive details about the run.\n* `repositoryId` (ID!): The node ID of the repository.\n* `startedAt` (DateTime): The time that the check run began.\n* `status` (RequestableCheckStatusState): The current status.\n\n## updateCheckSuitePreferences - mutation\n\nModifies the settings of an existing check suite.\n\n### Input fields for `updateCheckSuitePreferences`\n\n* `input` (UpdateCheckSuitePreferencesInput!): \n\n### Return fields for `updateCheckSuitePreferences`\n\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `repository` (Repository): The updated repository.\n\n## UpdateCheckSuitePreferencesInput - input object\n\nAutogenerated input type of UpdateCheckSuitePreferences.\n\n### Input fields for `UpdateCheckSuitePreferencesInput`\n\n* `autoTriggerPreferences` ([CheckSuiteAutoTriggerPreference!]!): The check suite preferences to modify.\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `repositoryId` (ID!): The Node ID of the repository."}