Objects

Check

A single analyzer check as part of an analysis run.

FieldTypeDescription
idID!The ID of the object.
sequenceInt!Sequence number of the check in the analysis run it belongs to.
statusCheckStatus!The current status of the check.
analyzerAnalyzer!The analyzer related to the check.
createdAtDateTime!Time when the check was created.
updatedAtDateTime!Time when the check was last modified.
finishedAtDateTimeTime when the check finished.
summaryCheckSummary!Summary of the check.
occurrencesOccurrenceConnection!Issue occurrences found in the check.
offsetInt
beforeString
afterString
firstInt
lastInt
metricsRepositoryMetric!List of DeepSource metrics captured in the check.

CheckSummary

Summary of a check.

FieldTypeDescription
occurrencesIntroducedIntNumber of issues introduced in the check.
occurrencesResolvedIntNumber of issues resolved in the check.
occurrencesSuppressedIntNumber of issues marked as suppressed in the check.
occurrenceDistributionByCategoryOccurrenceDistributionByCategoryThe issue category distribution for the check.

Occurrence

FieldTypeDescription
idID!The ID of the object.
pathString!
beginLineInt!
beginColumnInt!
endLineInt!
endColumnInt!
issueIssue!
issueIssue!The definition of the issue which has been raised.
titleString!Title describing the issue which has been raised here.

CheckConnection

FieldTypeDescription
pageInfoPageInfo!Pagination data for this connection.
edges[CheckEdge]!Contains the nodes in this connection.
totalCountInt

CheckEdge

A Relay edge containing a Check and its cursor.

FieldTypeDescription
nodeCheckThe item at the end of the edge.
cursorString!A cursor for use in pagination.

OccurrenceConnection

FieldTypeDescription
pageInfoPageInfo!Pagination data for this connection.
edges[OccurrenceEdge]!Contains the nodes in this connection.
totalCountInt

OccurrenceEdge

A Relay edge containing a Occurrence and its cursor.

FieldTypeDescription
nodeOccurrenceThe item at the end of the edge.
cursorString!A cursor for use in pagination.