Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

should we provide 'suppressionJustification'? #254

Open
michaelcfanning opened this issue Jul 28, 2016 · 2 comments
Open

should we provide 'suppressionJustification'? #254

michaelcfanning opened this issue Jul 28, 2016 · 2 comments

Comments

@michaelcfanning
Copy link
Contributor

Many in-source suppression mechanisms provide a justification field. This information may be useful to persist to a log file, for auditing purposes.

if we provide a field, we need to be cognizant that a result can be suppressed in multiple locations, e.g., both in-source and as part of an external baseline. If we add something, is it a single member relevant to in-source suppressions only? Is there a member for each suppression state? Do we provide an array of justification strings, with no particular ordering or association?

Or take @rtaket's original suggestion: we should define a suppressions array on a result, each element of which might include information such as its justification and persistence location. We could add this data as an additional member (deprecating suppressionState).

@ghost ghost added this to the future milestone Aug 8, 2016
@ghost ghost added the result-management label Aug 8, 2016
@ghost
Copy link

ghost commented Aug 8, 2016

We could have

"results": [
  {
    "suppressions": [
      {
        "kind": "...",
        "justification": "..."
      }
    ]
  }
]

But we don't yet have a customer for this, so deferring.

@ghost
Copy link

ghost commented Aug 8, 2016

Also, Roslyn uses the current suppressionStates mechanism, so it would be breaking for them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant