Separate suppression status from kind #371
Labels
2.1.0-CSD.1
Will be fixed in SARIF v2.1.0 CSD.1.
design-improvement
impact-breaks-consumers
impact-breaks-producers
merged
Changes merged into provisional draft.
resolved-fixed
BACKGROUND
We currently have four values for
suppression.kind
:"suppressedInSource"
,"suppressedExternally"
,"underReview"
, and"suppressionRejected"
. You see that these really fall into two categories:"suppressedInSource"
and"suppressedExternally"
says how the result was suppressed, andunderReview
andsuppressionRejected
track the process of deciding whether the result should be suppressed.Not only are these different in semantics, but they are different in "number": a result might be suppressed in multiple ways, but it is in only one status at a time.
NOTE: We had a similar situation with
result.level
, which original included both "severity" values likewarning
anderror
, and "status" values likeopen
. So we splitresult.level
into two properties,level
andkind
.While we're at it, we tighten up the value names.
SCHEMA CHANGES
In the
suppression
object:kind
property, restrict the valid values to"inSource"
and"external"
.status
of typestring
, optional, with valid values"accepted"
,"underReview"
and"rejected"
, default:"accepted"
.The text was updated successfully, but these errors were encountered: