Class QueryGuardAllowlistEntry

Namespace

QueryGuard

Assembly

QueryGuard.Core.dll

Records that a specific repeated query is intentional, and why.

public sealed class QueryGuardAllowlistEntry

Inheritance

object

QueryGuardAllowlistEntry

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Remarks

The reason is not optional, and that is the entire design. "Turn this off" is not something a reviewer can evaluate; "bounded provider lookup, at most three report sections" is. An allowlist entry is a claim about the code that someone can check, and it appears in a pull request diff where they can.

A matched entry marks a finding as ignored. It never removes it: see docs/decisions/0003-detector-terminology.md. If we tell users some findings will be wrong, we owe them a way to say so that does not also make the tool blind.

Properties

FingerprintId

Gets the fingerprint identifier this entry matches, or null when it matches by query tag instead.

QueryTag

Gets the query tag this entry matches, or null when it matches by fingerprint instead.

Reason

Gets why the repetition is intentional.

Methods

ForFingerprint(string, string)

Allows a specific fingerprint.

ForQueryTag(string, string)

Allows any query carrying a given tag.

Matches(string?, IReadOnlyList<string>?)

Determines whether this entry matches a finding's fingerprint and tags.

ToString()

Returns a string that represents the current object.