Skip to content

Commit 72fe41a

Browse files
dimakiswtrocki
authored andcommitted
docs: updated docs for new release of rhoas guidelines
1 parent 182b60d commit 72fe41a

File tree

2 files changed

+10
-14
lines changed

2 files changed

+10
-14
lines changed

spectral/README.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,24 @@ A custom ruleset for [Spectral](https://stoplight.io/open-source/spectral/) foll
99
To use this Spectral ruleset add the following to your `.spectral.yaml`:
1010

1111
```yaml
12-
extends: '@rhoas/spectral-ruleset'
12+
extends: 'node_modules/@rhoas/spectral-ruleset/dist/ruleset.yaml'
1313
```
1414
1515
Alternatively you need to create new ruleset
16-
17-
`
18-
echo "extends: '@rhoas/spectral-ruleset'" > .spectral.yaml
19-
`
20-
21-
Run the Spectral CLI:
22-
23-
```shell
24-
npm install -g @stoplight/[email protected]
25-
spectral lint ./path/to/openapi.yaml
16+
```
17+
echo 'extends: node_modules/@rhoas/spectral-ruleset/dist/ruleset.yaml' > .spectral.yaml
2618
```
2719
28-
or with yarn:
20+
Run the Spectral CLI with yarn:
2921
```shell
30-
yarn add global @stoplight/spectral-[email protected]
22+
yarn add @rhoas/spectral-ruleset
3123
yarn spectral lint ./path/to/openapi.yaml
3224
```
25+
or npm:
26+
```shell
27+
npm i -g @rhoas/spectral-ruleset
28+
spectral lint ./path/to/openapi.yaml
29+
```
3330

3431
## Rules
3532

spectral/ruleset.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ rules:
1111
no-$ref-siblings: warn
1212
oas3-valid-media-example: warn
1313

14-
1514
rhoas-external-$ref:
1615
given: "$..['$ref']"
1716
severity: error

0 commit comments

Comments
 (0)