Please see Documentation
This repository serves as the Central Contract Repository for the API Specifications / Contracts the govern interactions between below applications
To verify backward compatibility between API Specifications in your branch and the main branch on your local machine run below command.
ls **/*.yaml | xargs ./backward_compatibility.sh
echo $?
The echo $?
for Specmatic behaves like any other command line tool returning "0" for success and "1" for failure.
Below are the instructions to run the linter on your local machine
- Install spectral
- Run below command inside the repo
spectral lint **/*.yaml
- Above command leverages .spectral.yaml