Skip to content

Commit

Permalink
Update ci-fix.md: link to LintDiff rules.md + make the ruleset more d…
Browse files Browse the repository at this point in the history
…iscoverable (#23509)
  • Loading branch information
Konrad Jamrozik authored Apr 11, 2023
1 parent 7561be5 commit b065afa
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions documentation/ci-fix.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,13 @@ Please see [readme](https://github.com/Azure/openapi-diff/blob/main/README.md) f
Or you can run it in [OpenAPI Hub](https://portal.azure-devex-tools.com/tools/diff).
Refer to [Oad Docs](https://github.com/Azure/openapi-diff/tree/main/docs) for detailed description of all oad rules.

## Linter Diff Validation
## LintDiff Validation

The [LintDiff validation tool](https://github.com/Azure/azure-openapi-validator) runs linting rules against specification difference. Two specifications are compared: the specification as it would be when proposed PR is merged, vs the specification as seen before the PR is merged.

Refer to [openapi-authoring-automated-guidelines](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-automated-guidelines.md) for detailed description of all lint rules and how-to-fix guidance.
If that guidance is not enough, please also refer to the [LintDiff rules.md doc](https://github.com/Azure/azure-openapi-validator/blob/main/docs/rules.md). It links to `.md` files related to given error, containing instructions how to fix them.

The lint diff validation is to run linter against the currect spec and the spec before current PR , the final result is the differece set between the result running against current specs and the result running against the specs before current PR.
### Run linter locally:

#### Prerequisites:
Expand All @@ -88,7 +92,6 @@ autorest --v3 --spectral --validation --azure-validator --use=@microsoft.azure/o

Please see [readme](https://github.com/Azure/azure-openapi-validator/blob/main/README.md) for how to install or run tool in details.
Or you can run it in [OpenAPI Hub](https://portal.azure-devex-tools.com/tools/linter).
Refer to [openapi-authoring-automated-guidelines](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/openapi-authoring-automated-guidelines.md) for detailed description of all lint rules and how-to-fix guidance.

## Avocado

Expand Down

0 comments on commit b065afa

Please sign in to comment.