Skip to content

Commit 765e05d

Browse files
authored
Merge pull request #22 from Checkmarx/fix-21
update readme on `fail-on` status
2 parents 092a183 + 4aa5215 commit 765e05d

2 files changed

Lines changed: 8 additions & 4 deletions

File tree

API.md

Lines changed: 4 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,10 @@ new KicsValidator({
8383
});
8484
```
8585

86-
The other option is to provide `failureSeverities` if you still want to show
87-
the query in the results, but you don't want it to fail the execution.
86+
Alternatively, you can use the `failureSeverities` parameter when initiating a scan, enabling you to precisely define the criteria for considering a scan unsuccessful based on the severity of its results. Any result with a severity lower than the specified ones will not prompt a failure.
87+
88+
Please note that scans configured to only fail on certain severity levels might not display results falling below those specified levels.
89+
8890
By default this is set to `[Severity.HIGH, Severity.MEDIUM]`.
8991

9092
```ts

0 commit comments

Comments
 (0)