Skip to content

Commit

Permalink
docs(cli): remove -s alias from docs
Browse files Browse the repository at this point in the history
  • Loading branch information
PagoNxt-Trade committed Dec 20, 2022
1 parent 11539a6 commit 01004ea
Showing 1 changed file with 2 additions and 8 deletions.
10 changes: 2 additions & 8 deletions docs/guides/2-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Other options include:
--stdin-filepath path to a file to pretend that stdin comes from [string]
--resolver path to custom json-ref-resolver instance [string]
-r, --ruleset path/URL to a ruleset file [string]
--scoring-config path/URL to a scoring config file [string]
--scoring-config path/URL to a scoring config file [string]
-F, --fail-severity results of this level or above will trigger a failure exit code
[string] [choices: "error", "warn", "info", "hint"] [default: "error"]
-D, --display-only-failures only output results equal to or greater than --fail-severity [boolean] [default: false]
Expand Down Expand Up @@ -72,20 +72,14 @@ The scoring is produced in two different metrics:

Also it introduces a quality gate, were an API scoring below the specific threshold will fail in a pipeline.

Enabling scoring is done using a new parameter called --scoring-config or -s and the scoring configuration file, where you can define how an error or a warning affects to the scoring
Enabling scoring is done using a new parameter called --scoring-config and the scoring configuration file, where you can define how an error or a warning affects to the scoring

Usage:

```bash
spectral lint ./reference/**/*.oas*.{json,yml,yaml} --ruleset mycustomruleset.js --scoring-config ./scoringFile.json
```

or

```bash
spectral lint ./reference/**/*.oas*.{json,yml,yaml} -r mycustomruleset.js -s ./scoringFile.json
```

Heres an example of this scoringFile config file:

```
Expand Down

0 comments on commit 01004ea

Please sign in to comment.