modulecheck-reporting:sarif/modulecheck.reporting.sarif/SarifRule

SarifRule

@JsonClass(generateAdapter = true)

data class SarifRule(@Json(name = "helpUri") val helpURI: String? = null, @Json(name = "id") val id: String, @Json(name = "name") val name: String? = null, @Json(name = "defaultConfiguration") val defaultConfiguration: ReportingConfiguration? = null, @Json(name = "shortDescription") val shortDescription: MultiformatMessageString? = null, @Json(name = "fullDescription") val fullDescription: MultiformatMessageString? = null, @Json(name = "deprecatedGuids") val deprecatedGuids: List<String>? = null, @Json(name = "deprecatedIds") val deprecatedIDS: List<String>? = null, @Json(name = "deprecatedNames") val deprecatedNames: List<String>? = null, @Json(name = "guid") val guid: String? = null, @Json(name = "help") val help: MultiformatMessageString? = null, @Json(name = "messageStrings") val messageStrings: Map<String, MultiformatMessageString>? = null, @Json(name = "properties") val properties: PropertyBag? = null, @Json(name = "relationships") val relationships: List<ReportingDescriptorRelationship>? = null)(source)

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

Since

0.12.0

Constructors

SarifRule

constructor(@Json(name = "helpUri") helpURI: String? = null, @Json(name = "id") id: String, @Json(name = "name") name: String? = null, @Json(name = "defaultConfiguration") defaultConfiguration: ReportingConfiguration? = null, @Json(name = "shortDescription") shortDescription: MultiformatMessageString? = null, @Json(name = "fullDescription") fullDescription: MultiformatMessageString? = null, @Json(name = "deprecatedGuids") deprecatedGuids: List<String>? = null, @Json(name = "deprecatedIds") deprecatedIDS: List<String>? = null, @Json(name = "deprecatedNames") deprecatedNames: List<String>? = null, @Json(name = "guid") guid: String? = null, @Json(name = "help") help: MultiformatMessageString? = null, @Json(name = "messageStrings") messageStrings: Map<String, MultiformatMessageString>? = null, @Json(name = "properties") properties: PropertyBag? = null, @Json(name = "relationships") relationships: List<ReportingDescriptorRelationship>? = null)

Properties

defaultConfiguration

val defaultConfiguration: ReportingConfiguration? = null

Default reporting configuration information.

deprecatedGuids

val deprecatedGuids: List<String>? = null

An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool.

deprecatedIDS

val deprecatedIDS: List<String>? = null

An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.

deprecatedNames

val deprecatedNames: List<String>? = null

An array of readable identifiers by which this report was known in some previous version of the analysis tool.

fullDescription

val fullDescription: MultiformatMessageString? = null

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

guid

val guid: String? = null

A unique identifer for the reporting descriptor in the form of a GUID.

help

val help: MultiformatMessageString? = null

Provides the primary documentation for the report, useful when there is no online documentation.

helpURI

val helpURI: String? = null

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

val id: String

A stable, opaque identifier for the report.

messageStrings

val messageStrings: Map<String, MultiformatMessageString>? = null

A set of name/value pairs with arbitrary names. Each value is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.

name

val name: String? = null

A report identifier that is understandable to an end user.

properties

val properties: PropertyBag? = null

Key/value pairs that provide additional information about the report.

relationships

val relationships: List<ReportingDescriptorRelationship>? = null

An array of objects that describe relationships between this reporting descriptor and others.

shortDescription

val shortDescription: MultiformatMessageString? = null

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.