Skip to content

Commit cadb9ca

Browse files
rollback changes
1 parent 7a1f68d commit cadb9ca

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

tools/spectral/ipa/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ spectral lint {path/to/oas/file} --ruleset=./tools/spectral/ipa/ipa-spectral.yam
3232
The rule validations are custom JS functions (see [/rulesets/functions](https://github.com/mongodb/openapi/tree/main/tools/spectral/ipa/rulesets/functions)). To learn more about custom functions, refer to the [Spectral Documentation](https://docs.stoplight.io/docs/spectral/a781e290eb9f9-custom-functions).
3333

3434
The custom rule implementation allows for:
35-
3635
- Advanced validations not available using the standard Spectral rules
3736
- Custom exception handling
3837
- Metrics collection
@@ -50,8 +49,8 @@ Instead of using the [Spectral overrides approach](https://docs.stoplight.io/doc
5049
## Testing
5150

5251
- IPA Validation related code is tested using [Jest](https://jestjs.io/)
53-
- Each custom validation function has tests, located in [/\_\_tests\_\_](https://github.com/mongodb/openapi/tree/main/tools/spectral/ipa/__tests__). They use the test hook [testRule.js](https://github.com/mongodb/openapi/blob/main/tools/spectral/ipa/__tests__/__helpers__/testRule.js) as a common approach for Spectral rule testing
54-
- Helper/util functions are tested as well, see [/\_\_tests\_\_/utils](https://github.com/mongodb/openapi/tree/main/tools/spectral/ipa/__tests__/utils)
52+
- Each custom validation function has tests, located in [/\__tests\__](https://github.com/mongodb/openapi/tree/main/tools/spectral/ipa/__tests__). They use the test hook [testRule.js](https://github.com/mongodb/openapi/blob/main/tools/spectral/ipa/__tests__/__helpers__/testRule.js) as a common approach for Spectral rule testing
53+
- Helper/util functions are tested as well, see [/\__tests\__/utils](https://github.com/mongodb/openapi/tree/main/tools/spectral/ipa/__tests__/utils)
5554

5655
Install necessary dependencies with `npm install` if you haven't already. All Jest tests can be run with:
5756

tools/spectral/ipa/rulesets/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,4 @@ For rule definitions, see [IPA-123.yaml](https://github.com/mongodb/openapi/blob
5858
| Rule Name | Description | Severity |
5959
| ------------------------------------------------- | ------------------------------------------------------- | -------- |
6060
| xgen-IPA-123-enum-values-must-be-upper-snake-case | Enum values must be UPPER_SNAKE_CASE. http://go/ipa/123 | warn |
61+

0 commit comments

Comments
 (0)