You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: spectral/README.md
+9-1Lines changed: 9 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,8 @@ A custom ruleset for [Spectral](https://stoplight.io/open-source/spectral/) foll
4
4
5
5
## Using
6
6
7
+
> [npm](https://docs.npmjs.com/) is required to use Spectral.
8
+
7
9
To use this Spectral ruleset add the following to your `.spectral.yaml`:
8
10
9
11
```yaml
@@ -12,6 +14,12 @@ rules:
12
14
# add your custom rules here
13
15
```
14
16
17
+
Run the Spectral CLI:
18
+
19
+
```shell
20
+
npx @stoplight/spectral ./path/to/openapi.yaml
21
+
```
22
+
15
23
## Rules
16
24
17
25
The RHOAS ruleset extends the Spectral built-in "oas" ruleset (except `operation-tags`, `openapi-tags`). You can see the full list of rules from that ruleset [here](https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md)
@@ -241,4 +249,4 @@ Validate OpenAPI files using the uncompiled ruleset:
0 commit comments