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
If adding new rules or updating `.spectral.yaml` overall, the validations will instantly get updated across the `mongodb/openapi` repository.
3
+
A set of custom validator rules for the MongoDB Atlas Programmatic API, adhering to API Standards (IPA)
4
+
## Structure
4
5
5
-
Please perform the following steps:
6
+
-**/ipa** - Contains custom Spectral rulesets covering MongoDB API standards.
7
+
-**/.spectral.yaml** - Contains validators not specifically related to API standards.
6
8
7
-
1. Open a `mongodb/openapi` PR with the changes to `tools/spectral/.spectral.yaml`
8
-
2. Validate that the new Spectral lint checks pass
9
-
3. Review and merge the PR
9
+
### Custom Rules
10
10
11
-
**Note:** For MongoDB engineers, please review http://go/openapi-spectral-updates.
11
+
For a complete list of implemented rules, please refer to the [Ruleset Documentation](./ipa/rulesets/README.md).
12
+
13
+
### Updating the .spectral.yaml Ruleset
14
+
15
+
When adding new rules or updating the `.spectral.yaml` file, the validations will automatically update across the `mongodb/openapi` repository. Follow these steps:
16
+
17
+
1. Open a pull request (PR) in the `mongodb/openapi` repository with changes to `tools/spectral/.spectral.yaml`.
18
+
2. Ensure that the new Spectral lint checks pass.
19
+
3. Review and merge the PR.
20
+
21
+
### Internal Documentation
22
+
23
+
- Refer to the [IPA Standards](http://go/ipa) for specific rules.
24
+
- Visit the [Spectral Wiki](http://go/openapi-spectral-updates) for additional information.
0 commit comments