Skip to content

Commit 4144211

Browse files
committed
fix: broken readme
1 parent 57b4665 commit 4144211

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

spectral/README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +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: 'node_modules/@rhoas/spectral-ruleset/dist/ruleset.yaml'
12+
extends: '@rhoas/spectral-ruleset'
1313
```
1414
1515
Alternatively you need to create new ruleset
16-
```
17-
echo 'extends: node_modules/@rhoas/spectral-ruleset/dist/ruleset.yaml' > .spectral.yaml
16+
17+
```shell
18+
echo 'extends: @rhoas/spectral-ruleset' > .spectral.yaml
1819
```
1920
2021
Run the Spectral CLI with yarn:
22+
2123
```shell
2224
yarn add @rhoas/spectral-ruleset
2325
yarn spectral lint ./path/to/openapi.yaml
2426
```
27+
2528
or npm:
29+
2630
```shell
2731
npm i -g @rhoas/spectral-ruleset
2832
spectral lint ./path/to/openapi.yaml
@@ -60,7 +64,7 @@ servers:
6064

6165
**Severity**: warning
6266

63-
### rhoas-info-license-apache2.0:
67+
### rhoas-info-license-apache2.0
6468

6569
The `info.license.name` field must be "Apache 2.0".
6670

@@ -73,7 +77,7 @@ info:
7377
**Recommended**: Yes
7478
**Severity**: warning
7579

76-
### rhoas-info-license-apache2.0-url:
80+
### rhoas-info-license-apache2.0-url
7781

7882
The `info.license.url` field must have the correct link for Apache 2.0.
7983

@@ -94,7 +98,7 @@ All paths must match the specified regular expression: `\/api\/([a-z_]*){1,}(\/v
9498
- The first segment must be `/api`
9599
- The second segement denotes the service name (e.g. `/api/kafkas_mgmt`) and may only be `snake_case`.
96100
- The third segment must specify the API version. This can be a major version such as `v1` or a channel-version such as `v1beta`, `v1alpha`.
97-
- All following segments must follow `snake_case` and can only contain alphabetical characters along and underscores but can be repeated (e.g. `/api/kafkas_mgmt/v1/kafkas/{id}/useful_metrics`)
101+
- All following segments must follow `snake_case` and can only contain alphabetical characters along and underscores but can be repeated (e.g. `/api/kafkas_mgmt/v1/kafkas/{id}/useful_metrics`)
98102

99103
**Recommended**: Yes
100104
**Severity**: warning
@@ -142,6 +146,7 @@ All JSON schema objects defined in `components.schemas` must follow `PascalCase`
142146
**Recommended**: Yes
143147

144148
**Severity**: warning
149+
145150
### rhoas-schema-properties-snake-case
146151

147152
All JSON schema properties defined must follow `snake_case`.

0 commit comments

Comments
 (0)