Reference: Enums

AccountType

Value	Description
INDIVIDUAL	A individual account.
TEAM	A team account.

Represents DeepSource's subscription plans.

An enumeration.

Value	Description
PENDING	The Analysis run is still pending and results are awaited.
SUCCESS	The Analysis has completed successfully and no issues were found.
FAILURE	The Analysis has completed succesfully and some issues were detected by DeepSource.
TIMEOUT	The Analysis could not complete within an acceptable time range.
CANCEL	Another analysis was started for the same commitID.
READY

An enumeration.

Sort key to use to specify the sorting when fetching repositories in the Code Coverage report.

Value	Description
LCV_ASCENDING	Sort repositories in the Code Coverage report using the LCV metric value in ascending order.
LCV_DESCENDING	Sort repositories in the Code Coverage report using the LCV metric value in descending order.
BCV_ASCENDING	Sort repositories in the Code Coverage report using the BCV metric value in ascending order.
BCV_DESCENDING	Sort repositories in the Code Coverage report using the BCV metric value in descending order.

An enumeration.

Value	Description
ANTI_PATTERN	Anti-patterns are certain ways of writing code that result in poor design. While anti-patterns are correct code, they are not recommended as they often affect maintainability, readability, performance, and security.
BUG_RISK	Bug risks are issues in code that can cause errors in code and breakages in production. A bug is a flaw in the code that produces undesired or incorrect results.
PERFORMANCE	Performance issues are issues that impact the performance of code being executed by slowing it down.
SECURITY	A bug in code which could potentially be used to compromise security is a security vulnerability issue.
COVERAGE	Coverage issues are raised against code that is not covered in tests.
TYPECHECK	Typecheck issues are raised for type-annotated code in dynamically typed languages (Python, for example) if the annotations are not correct.
SECRETS	Hardcoded credentials detected in source code.
STYLE	Style issues are violations in the code format according to a style guide.
DOCUMENTATION	Documentation issues are raised for undocumented classes, functions, modules etc.

An enumeration.

Represents the various kinds of reports that exist.

Value	Description
OWASP_TOP_10	The OWASP Top 10 report.
SANS_TOP_25	The SANS Top 25 report.
ISSUE_DISTRIBUTION	The Issue Distribution report.

Represents the various statuses that a report can have.

Value	Description
PASSING	The report's status is passing.
FAILING	The report's status is failing.
NOOP	The report doesn't have a status.

An enumeration.

Represents the various metric types.

Represents the key for which the metric is recorded in a repository.

Represents the status of the threshold condition for a particular metric value.

Value	Description
PASSING	Metric value meets the threshold.
FAILING	Metric value doesn't meet the threshold.

Represents the role of a user in a team.

Represents the level of an IgnoreRule.

Value	Description
REPOSITORY	Suppress the issue for all files in the repository.
FILE	Suppress the issue for the given file path in the repository.

Represents the type of an IgnoreRule.

Value	Description
FOREVER	Suppress the issue in the repository always.
PATTERN	Suppress the issue occurrences matching the given glob pattern in the repository.
TEST_PATTERN	Suppress the issue occurrences matching the repository's specified test patterns in the repository.