Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update the ruleset file location/usage

Browse Source 
Put it as referenced in the linting example
This commit is contained in:
Andrzej
2019-12-03 10:15:28 +01:00
committed by GitHub
parent d9b7fbec71
commit 2d5e4fa374
1 changed files with 2 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
general-guidelines/validating-api-descriptions.md
View File

@@ -50,12 +50,10 @@ Spectral can also be used from within JavaScript. For details on how to accompli
## Validating with Adidas API Guidelines
To check whether your API Specification complies with Adidas API Guidelines copy the `.spectral` file from this repository ([here](https://github.com/adidas/api-guidelines/blob/master/.spectral.yml)).
Once it is in the same directory as the one from which you are calling spectral it will be used automatically.
To check whether your API Specification complies with Adidas API Guidelines you will need the `.spectral.yaml` file from this repository ([here](https://github.com/adidas/api-guidelines/blob/master/.spectral.yml)).
```
spectral lint <oas-file>
spectral lint <oas-file> -r path/.spectral.yaml
```
### Validation problems