Bitbucket Data Center API Client
    Preparing search index...

    Interface AddInsightAnnotationData

    Payload for adding or replacing a single Code Insights annotation.

    https://developer.atlassian.com/server/bitbucket/rest/v1003/api-group-builds-and-deployments/#api-insights-latest-projects-projectkey-repos-repositoryslug-commits-commitid-reports-key-annotations-post

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

    Properties

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

    Properties

    externalId?: string

    Identifier assigned by the reporting tool; unique within the report

    line?: number

    Line to annotate; omit (or 0) to annotate the whole file

    link?: string

    Link to the finding in the reporting tool

    message: string

    The finding's message, max 2000 characters

    path?: string

    Path of the annotated file, relative to the repository root

    severity: InsightAnnotationSeverity
    type?: InsightAnnotationType

    Settings

    Member Visibility

    On This Page

    Properties