Skip to content

Commit 7f901f4

Browse files
author
Sophia Marie Terry
committed
README updates
1 parent 70aad57 commit 7f901f4

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

tools/spectral/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MongoDB API Spectral Validation
22

3-
A set of custom validation rules for the MongoDB Atlas Programmatic API, adhering to API Standards (IPA).
3+
A set of custom validation rules for the MongoDB Atlas Programmatic API, adhering to MongoDB API standards - [Improvement Proposal for APIs](https://mongodb.github.io/ipa/) (IPA).
44

55
## Structure
66

tools/spectral/ipa/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ The IPA validation uses [Spectral](https://docs.stoplight.io/docs/spectral/9ffa0
1111
| Installation & Usage | [IPA README](https://github.com/mongodb/openapi/tree/main/tools/spectral/ipa#readme) |
1212
| Implemented Rules | [Ruleset Documentation](https://github.com/mongodb/openapi/tree/main/tools/spectral/ipa/rulesets#readme) |
1313
| Spectral Docs | [Spectral](https://docs.stoplight.io/docs/spectral/674b27b261c3c-overview) |
14-
| Spectral Wiki (Internal) | [http://go/openapi-spectral-updates](http://go/openapi-spectral-updates) |
1514
| Contributing | [CONTRIBUTING.md](https://github.com/mongodb/openapi/blob/main/tools/spectral/CONTRIBUTING.md) |
1615
| Changelog | [CHANGELOG.md](https://github.com/mongodb/openapi/blob/main/tools/spectral/CHANGELOG.md) |
1716
| Issues | [https://github.com/mongodb/openapi/issues](https://github.com/mongodb/openapi/issues) |
@@ -48,6 +47,9 @@ extends:
4847
- https://raw.githubusercontent.com/mongodb/openapi/<latest-git-commit-sha>/tools/spectral/ipa/ipa-spectral.yaml
4948
```
5049

50+
##### Limitations
51+
The IPA Validation Framework uses a third party dependency to validate OperationIDs. With this approach, server based installation is only supported via cloning the repo or via package-based installation.
52+
5153
#### Package-based Installation (**TO BE RELEASED**)
5254
Run:
5355
```
@@ -68,18 +70,21 @@ Create a `.spectral.yaml` file that extends our ruleset:
6870

6971
```
7072
extends:
71-
- https://raw.githubusercontent.com/mongodb/openapi/<latest-git-commit-sha>/tools/spectral/ipa/ipa-spectral.yaml
73+
- "@mongodb/ipa-validation-ruleset"
7274
```
7375

7476
or
7577

7678
```
7779
extends:
78-
- "@mongodb/ipa-validation-ruleset"
80+
- https://raw.githubusercontent.com/mongodb/openapi/<latest-git-commit-sha>/tools/spectral/ipa/ipa-spectral.yaml
7981
```
8082

8183
For more information about how to extend rulesets, see the [web page](https://meta.stoplight.io/docs/spectral/83527ef2dd8c0-extending-rulesets).
8284

85+
##### Limitations
86+
Due to usage of a third party dependency to validate OperationIDs, the server based appraoch is only supported via cloning the repo.
87+
8388
#### Customization Options
8489

8590
You can override specific rules from our ruleset by adding them to your local `.spectral.yaml`:

0 commit comments

Comments
 (0)