Objects
Check
A single analyzer check as part of an analysis run.
| Field |
Type |
Description |
| id |
ID! |
The ID of the object. |
| sequence |
Int! |
Sequence number of the check in the analysis run it belongs to. |
| status |
CheckStatus! |
The current status of the check. |
| analyzer |
Analyzer! |
The analyzer related to the check. |
| createdAt |
DateTime! |
Time when the check was created. |
| updatedAt |
DateTime! |
Time when the check was last modified. |
| finishedAt |
DateTime |
Time when the check finished. |
| summary |
CheckSummary! |
Summary of the check. |
| occurrences |
OccurrenceConnection! |
Issue occurrences found in the check. |
| offset |
Int |
|
| before |
String |
|
| after |
String |
|
| first |
Int |
|
| last |
Int |
|
| metrics |
[RepositoryMetric!] |
List of DeepSource metrics captured in the check. |
CheckSummary
Summary of a check.
| Field |
Type |
Description |
| occurrencesIntroduced |
Int |
Number of issues introduced in the check. |
| occurrencesResolved |
Int |
Number of issues resolved in the check. |
| occurrenceDistributionByCategory |
[OccurrenceDistributionByCategory] |
The issue category distribution for the check. |
Occurrence
| Field |
Type |
Description |
| id |
ID! |
The ID of the object. |
| path |
String! |
|
| beginLine |
Int! |
|
| beginColumn |
Int! |
|
| endLine |
Int! |
|
| endColumn |
Int! |
|
| issue |
Issue! |
|
| issue |
Issue! |
The definition of the issue which has been raised. |
| title |
String! |
Title describing the issue which has been raised here. |
CheckConnection
| Field |
Type |
Description |
| pageInfo |
PageInfo! |
Pagination data for this connection. |
| edges |
[CheckEdge]! |
Contains the nodes in this connection. |
| totalCount |
Int |
|
CheckEdge
A Relay edge containing a Check and its cursor.
| Field |
Type |
Description |
| node |
Check |
The item at the end of the edge. |
| cursor |
String! |
A cursor for use in pagination. |
OccurrenceConnection
| Field |
Type |
Description |
| pageInfo |
PageInfo! |
Pagination data for this connection. |
| edges |
[OccurrenceEdge]! |
Contains the nodes in this connection. |
| totalCount |
Int |
|
OccurrenceEdge
A Relay edge containing a Occurrence and its cursor.
| Field |
Type |
Description |
| node |
Occurrence |
The item at the end of the edge. |
| cursor |
String! |
A cursor for use in pagination. |