Skip to content

Commit 7737688

Browse files
author
Sophia Marie Terry
committed
Add note about package based installation
1 parent 9dbd288 commit 7737688

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

tools/spectral/ipa/README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -39,26 +39,25 @@ To incorporate the IPA Spectral ruleset for OpenAPI specification validation in
3939

4040
### Installation Options
4141

42-
#### Package-based Installation
42+
#### Server-based Installation
4343

44-
Run:
45-
```
46-
npm install @mongodb/ipa-validation-ruleset
47-
```
44+
You can reference our ruleset directly in your `.spectral.yaml` file without installation:
4845

49-
Then reference the ruleset directly in your `.spectral.yaml` file:
5046
```
5147
extends:
52-
- "@mongodb/ipa-validation-ruleset"
48+
- https://raw.githubusercontent.com/mongodb/openapi/<latest-git-commit-sha>/tools/spectral/ipa/ipa-spectral.yaml
5349
```
5450

55-
#### Server-based Installation
56-
57-
You can reference our ruleset directly in your `.spectral.yaml` file without installation:
51+
#### Package-based Installation (**TO BE RELEASED**)
52+
Run:
53+
```
54+
npm install @mongodb-js/ipa-validation-ruleset
55+
```
5856

57+
Then reference the ruleset directly in your `.spectral.yaml` file:
5958
```
6059
extends:
61-
- https://raw.githubusercontent.com/mongodb/openapi/<latest-git-commit-sha>/tools/spectral/ipa/ipa-spectral.yaml
60+
- "@mongodb-js/ipa-validation-ruleset"
6261
```
6362

6463
### Integration Methods

0 commit comments

Comments
 (0)