Skip to content

Commit 7a1f68d

Browse files
rollback changes
1 parent 97c5bbf commit 7a1f68d

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

tools/spectral/ipa/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ 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+
3536
- Advanced validations not available using the standard Spectral rules
3637
- Custom exception handling
3738
- Metrics collection
@@ -49,8 +50,8 @@ Instead of using the [Spectral overrides approach](https://docs.stoplight.io/doc
4950
## Testing
5051

5152
- IPA Validation related code is tested using [Jest](https://jestjs.io/)
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)
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)
5455

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

0 commit comments

Comments
 (0)