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

Add working version

Browse Source
This commit is contained in:
solanfel
2022-04-07 11:07:29 +02:00
parent d10e8a9043
commit 3d0007b920
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -47,12 +47,14 @@ In the `ruleset.md` file you can find a digest of API Guidelines rules which you
To install Spectral you will need Node.js and a package manager (npm or yarn). To install Spectral you will need Node.js and a package manager (npm or yarn).
Note: The version used with the spectal specifictions was 5.3.0
``` ```
npm install -g @stoplight/spectral npm install -g @stoplight/spectral@5.3.0
# OR # OR
yarn global add @stoplight/spectral yarn global add @stoplight/spectral@5.3.0
``` ```
Once installed, to verify your OAS file with spectral execute `spectral lint <oas-file> -r <adidas-api-guidelines-folder>/.spectral.yaml` where `<adidas-api-guidelines-folder>/.spectral.yaml` indicated the location `.spectral.yaml` file. Once installed, to verify your OAS file with spectral execute `spectral lint <oas-file> -r <adidas-api-guidelines-folder>/.spectral.yaml` where `<adidas-api-guidelines-folder>/.spectral.yaml` indicated the location `.spectral.yaml` file.