Enums

AccountType

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

AccountSubscriptionPlan

Represents DeepSource's subscription plans.

Value	Description
FREE	Free plan.
STARTER	Starter plan.
BUSINESS	Business plan.
ENTERPRISE	Enterprise plan.

AnalysisRunStatus

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	The analysis run is ready to start processing.
SKIPPED	The analysis run was skipped.

CheckStatus

An enumeration.

Value	Description
WAITING	The check is waiting to be picked up for processing.
PENDING	The check is being processed.
SUCCESS	The check completed successfully with no issues found.
FAILURE	The check completed and issues were detected.
TIMEOUT	The check could not complete within the allowed time.
CANCEL	The check was cancelled.
READY	The check is ready to start processing.
NEUTRAL	The check completed with a neutral result.
ARTIFACT_TIMEOUT	The check timed out waiting for artifacts.
SKIPPED	The check was skipped.

CodeCoverageReportRepositorySortKey

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.

IssueCategory

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.

IssueSeverity

An enumeration.

Value	Description
CRITICAL	Critical severity. Requires immediate attention.
MAJOR	Major severity. Should be fixed soon.
MINOR	Minor severity. Can be addressed later.

ReportKey

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.
MISRA_C	The MISRA C report.
CODE_COVERAGE	The Code Coverage report.
CODE_HEALTH_TREND	The Code Health Trend report.
ISSUES_PREVENTED	The Issues Prevented report.
ISSUES_AUTOFIXED	The Issues Autofixed report.

ReportStatus

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.

VCSProvider

Represents the various version control systems that are supported for personal accounts and workspaces.

Value	Description
GITHUB	GitHub
GITHUB_ENTERPRISE	GitHub Enterprise
GITLAB	GitLab
BITBUCKET	Bitbucket
BITBUCKET_DATACENTER	Bitbucket Data Center
ADS	Azure DevOps Services
GSR	Google Source Repositories

MetricShortcode

Represents the various metric types.

Value	Description
BCV	Branch Coverage
CCV	Condition Coverage
DCV	Documentation Coverage
DDP	External Dependencies
LCV	Line Coverage
CPCV	Composite Coverage
NLCV	New Line Coverage
NBCV	New Branch Coverage
NCCV	New Condition Coverage
NCPCV	New Composite Coverage

MetricKey

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

Value
AGGREGATE
C_AND_CPP
CSHARP
GO
JAVA
JAVASCRIPT
PHP
PYTHON
RUBY
RUST
SCALA
KOTLIN
SWIFT

MetricThresholdStatus

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.

TeamMemberRole

Represents the role of a user in a team.

Value	Description
ADMIN	Full administrative access to the team.
MEMBER	Standard team member access.
CONTRIBUTOR	Limited contributor access.

IgnoreRuleLevel

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.

IgnoreRuleType

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.

VulnerabilitySeverity

Severity levels for vulnerabilities based on CVSS scores.

Value	Description
NONE	No severity (informational).
LOW	Low severity vulnerability.
MEDIUM	Medium severity vulnerability.
HIGH	High severity vulnerability.
CRITICAL	Critical severity vulnerability.

VulnerabilityOccurrenceReachability

The reachability status of a vulnerability occurrence.

Value	Description
REACHABLE	The vulnerable code is reachable from the application code.
UNREACHABLE	The vulnerable code is not reachable from the application code.
UNKNOWN	Reachability analysis could not determine the status.

VulnerabilityOccurrenceFixability

The fixability status of a vulnerability occurrence.

Value	Description
ERROR	An error occurred while determining fixability.
UNFIXABLE	The vulnerability cannot be fixed (no patch available).
GENERATING_FIX	DeepSource is currently generating a fix for the vulnerability.
POSSIBLY_FIXABLE	The vulnerability may be fixable.
MANUALLY_FIXABLE	The vulnerability can be fixed manually.
AUTO_FIXABLE	The vulnerability can be automatically fixed by DeepSource.

Ecosystem

Package ecosystems supported by DeepSource.

Value	Description
NPM	Node.js packages (npm).
PYPI	Python packages (PyPI).
MAVEN	Java packages (Maven).
GO	Go modules.
RUBYGEMS	Ruby gems.
NUGET	.NET packages (NuGet).
PACKAGIST	PHP packages (Packagist).
CRATES_IO	Rust packages (crates.io).

PackageManager

Package managers supported by DeepSource.

Value	Description
REQUIREMENTS_TXT	Python requirements.txt
POETRY	Python Poetry
PIPFILE	Python Pipfile
PDM	Python PDM
UV	Python uv
NPM	Node.js npm
YARN	Node.js Yarn
PNPM	Node.js pnpm
BUN	Node.js Bun
GRADLE	Java Gradle
MAVEN	Java Maven
GO_MOD	Go modules
RUBY_GEMS	Ruby Gems
NUGET	.NET NuGet
PACKAGIST	PHP Packagist
CARGO	Rust Cargo

RepositoryTargetSource

The source of a repository target configuration.

Value	Description
AUTO	Automatically detected by DeepSource.
CUSTOM	Manually configured by the user.

PackageVersionType

The type of package version.

Value	Description
SEMVER	Semantic versioning.
ECOSYSTEM	Ecosystem-specific versioning.
GIT	Git commit-based versioning.

AnalysisIssueSource

The source that detected an issue.

Value	Description
STATIC	Issue detected by static analysis.
AI	Issue detected by AI-powered analysis.

AnalyzerType

The type of analyzer.

Value	Description
CORE	A core analyzer maintained by DeepSource.
COMMUNITY	A community-contributed analyzer.
CUSTOM	A custom analyzer.

Direction

Represents a directional trend.

Value	Description
UPWARD	Upward trend.
DOWNWARD	Downward trend.

IssuePriorityType

Priority levels for issues.

Value	Description
LOW	Low priority issue.
MEDIUM	Medium priority issue.
HIGH	High priority issue.

PRState

The state of a pull request.

Value	Description
OPEN	The pull request is open.
CLOSED	The pull request is closed.

SCACheckStatus

Status values for SCA checks.

Value	Description
WAITING	The SCA check is waiting to be picked up for processing.
PENDING	The SCA check is being processed.
SUCCESS	The SCA check completed successfully with no vulnerabilities found.
FAILURE	The SCA check completed and vulnerabilities were detected.
TIMEOUT	The SCA check could not complete within the allowed time.
CANCEL	The SCA check was cancelled.
READY	The SCA check is ready to start processing.
NEUTRAL	The SCA check completed with a neutral result.
ARTIFACT_TIMEOUT	The SCA check timed out waiting for artifacts.
SKIPPED	The SCA check was skipped.

RunReportGrade

Grade values for run report cards.

Value	Description
A	Grade A.
B	Grade B.
C	Grade C.
D	Grade D.

RunReportStatus

Status values for run reports.

Value	Description
IN_PROGRESS	The report is being generated.
RECOMPUTE	The report is being recomputed.
COMPLETED	The report has been generated.
PENDING	The report generation is pending.

DeviceType

The type of device used for authentication.

Value	Description
CLI	Command-line interface device.
IDE	IDE device.

IDESubscriptionPlan

Subscription plans for IDE integrations.

Value	Description
FREE	Free plan.
PRO	Pro plan.
SPONSORED	Sponsored plan.

On this page