Thanks for your interest in openapi-validator-utils. Our goal is to provide some validator methods to the request, parameters, headers and responses based on the OpenAPI Docs.
openapi-validator-utils welcomes contributions from everyone.
Contributions to openapi-validator-utils should be made in the form of GitHub pull requests. Each pull request will be reviewed by a core contributor (@bri06 or @kevinccbsg) and either landed in the main tree or given feedback for changes that would be required.
openapi-validator-utils's open issues are here.
openapi-validator-utils's docs are here.
You can clone this repository and run this command to start using developing this package.
npm install
If you want to test it you can add a new test in this folder or you can create a new example here.
To execute package's tests you have run this command:
npm test
Please also ensure linting is correct while you're developing by running this command:
npm run lint
-
Check validations should pass. This one includes linting and testing.
-
Commits should be as small as possible, while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests).
-
If your patch is not getting reviewed or you need a specific person to review it, you can @-reply a reviewer asking for a review in the pull request or a comment.
We follow the openapi-validator-utils Code of Conduct.
All code in this repository is under MIT License.