This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
- Node (6.9.5 or higher)
- Node Package Manager
- Typescript (2.3.0 or higher)
The first step would be to run npm install
so we have all the required modules installed.
gulp build
This transpiles the typescript scripts into javascript files under the js folder.
gulp test
This runs the tests under tests directory.
- Add a typescript file under
azure-openapi-linter
directory named same as the name of the rule. Add theid
,name
,severity
,category
,mergeState
,openapiType
,appliesTo_JsonQuery
properties to the rule.appliesTo_JsonQuery
is the node(s) to which the rule needs to be applied. This is evaluated using JsonPaths. Please refer here for a brief tutorial about JsonPaths. - Next, implement the
run
method under the rule that actually does the validation. Add a reference to this script file undersrc\azure-openapi-linter\index.ts
. - Lastly add a test case for the validation rule, by adding a test json/yaml under
src\azure-openapi-linter\tests\resources
and a script undersrc\azure-openapi-linter\tests
depending on the type of the validation rule.