Package-level declarations

Types

Link copied to clipboard
@CacheableTask
abstract class AggregateApiWatchdogReportsTask : DefaultTask

Combines the API Watchdog reports of the projects declared in apiWatchdogReports.

Link copied to clipboard
Link copied to clipboard
data class ApiWatchdogIdeLinks(val project: ApiWatchdogIdeProject, val toolbox: Boolean, val tags: List<String>)

How the Open in IDE buttons open a source file.

Link copied to clipboard
data class ApiWatchdogIdeProject(val name: String, val rootDirectory: String) : Serializable

The IDE project that the Open in IDE buttons of the HTML report open.

Link copied to clipboard
data class ApiWatchdogProjectReport(val projectPath: String, val projectDirectory: String, val applied: List<AppliedExemptionReportEntry>, val notApplied: List<NotAppliedExemptionReportEntry>, val sourceSnippets: Map<String, ApiWatchdogSourceSnippet> = emptyMap())

The report of one project.

Link copied to clipboard
Link copied to clipboard

Writes the diagnostics without an exemption as a SARIF 2.1.0 log. A location is relative to the root directory of the build, so a code scanning service resolves it against the repository checkout.

Link copied to clipboard
data class ApiWatchdogSourceRange(val startLine: Int, val startColumn: Int, val endLine: Int, val endColumn: Int)

One-based source positions with an exclusive end.

Link copied to clipboard
data class ApiWatchdogSourceSnippet(val startLine: Int, val code: String)
Link copied to clipboard
data class AppliedExemptionReportEntry(val annotation: String, val location: String)

An @Intentionally* annotation in the sources. location is path:line, relative to the project directory.

Link copied to clipboard
@RequiresOptIn(message = "This API is internal to the Library API Watchdog plugins. It can change in any release.", level = RequiresOptIn.Level.ERROR)
annotation class InternalWatchdogApi

Marks a declaration that the watchdog plugins share between their artifacts.

Link copied to clipboard
data class NotAppliedExemptionReportEntry(val annotation: String?, val diagnostic: String, val location: String, val reason: String, val severity: String, val messageParameters: List<String> = emptyList(), val sourceRange: ApiWatchdogSourceRange? = null, val autoFixAvailable: Boolean = false)

A diagnostic without an exemption.

Link copied to clipboard
class WatchdogReportAggregationPlugin : Plugin<Project>

Combines the reports declared in apiWatchdogReports into one HTML report and one SARIF report by default.

Link copied to clipboard
abstract class WatchdogReports

The formats of the API Watchdog report. Each format has a switch and a file: