Interface CommitAnnotationsParams

Query parameters accepted by GET /rest/insights/latest/…/commits/{commitId}/annotations (annotations across all of the commit's reports).

interface CommitAnnotationsParams {
    externalId?: string;
    key?: string;
    path?: string;
    severity?: InsightAnnotationSeverity;
    type?: InsightAnnotationType;
}

Index

Properties

externalId? key? path? severity? type?

Properties

`Optional`externalId

externalId?: string

Filter by the annotation's external id

`Optional`key

key?: string

Filter by report key

`Optional`path

path?: string

Filter by annotated file path

`Optional`severity

severity?: InsightAnnotationSeverity

Filter by severity

`Optional`type

type?: InsightAnnotationType

Filter by annotation type