ReportingDescriptor

io.shiftleft.semanticcpg.sarif.SarifSchema.ReportingDescriptor

Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes

Members list

Value members

Abstract methods

def fullDescription: Option[Message]

Attributes

Returns

A description of the report. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.

def helpUri: Option[URI]

Attributes

Returns

A URI where the primary documentation for the report can be found.

def id: String

Attributes

Returns

A stable, opaque identifier for the report.

def name: String

Attributes

Returns

A report identifier that is understandable to an end user.

def shortDescription: Option[Message]

Attributes

Returns

A concise description of the report. Should be a single sentence that is understandable when visible space is limited to a single line of text.