Bitbucket Data Center API Client
    Preparing search index...

    Interface BitbucketInsightAnnotation

    A Code Insights annotation: a finding attached to a file/line of a commit, belonging to a report.

    interface BitbucketInsightAnnotation {
        externalId?: string;
        line?: number;
        link?: string;
        message: string;
        path?: string;
        reportKey?: string;
        severity: InsightAnnotationSeverity;
        type?: InsightAnnotationType;
    }
    Index

    Properties

    externalId? line? link? message path? reportKey? severity type?

    Properties

    externalId?: string

    Identifier assigned by the reporting tool; unique within the report

    line?: number

    Line the annotation refers to; 0 (or absent) annotates the whole file

    link?: string

    Link to the finding in the reporting tool

    message: string
    path?: string

    Path of the annotated file, relative to the repository root

    reportKey?: string

    Key of the report the annotation belongs to

    severity: InsightAnnotationSeverity
    type?: InsightAnnotationType

    Settings

    Member Visibility

    On This Page

    Properties