From 2d5e4fa3749188fed23f63612acde07bf874f8b9 Mon Sep 17 00:00:00 2001 From: Andrzej Date: Tue, 3 Dec 2019 10:15:28 +0100 Subject: [PATCH] Update the ruleset file location/usage Put it as referenced in the linting example --- general-guidelines/validating-api-descriptions.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/general-guidelines/validating-api-descriptions.md b/general-guidelines/validating-api-descriptions.md index d411281..57ca53d 100644 --- a/general-guidelines/validating-api-descriptions.md +++ b/general-guidelines/validating-api-descriptions.md @@ -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 +spectral lint -r path/.spectral.yaml ``` ### Validation problems