From 03c98e8708f9fdcc5aadb06df641eb73556eb123 Mon Sep 17 00:00:00 2001 From: Ray Chen Date: Fri, 27 Mar 2020 21:21:36 +0800 Subject: [PATCH] Updated CI fix document (#8801) * Add free-form object spec for testing purpose. * Revert "Add free-form object spec for testing purpose." This reverts commit b711d809b6ae964fcbe7d04f31fec76db8798438. * Updated ci-fix document. Added how to run/fix model validation and semantic validation. * Combined run locally and fix tips parts. * Tweaked link text. --- documentation/ci-fix.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/documentation/ci-fix.md b/documentation/ci-fix.md index bfc691b42599..38fc8d40ab9a 100644 --- a/documentation/ci-fix.md +++ b/documentation/ci-fix.md @@ -23,3 +23,24 @@ npm install; npm run prettier -- --write "specification//**/*.json" ``` Then please commit and push changes made by prettier. + +## Model Validation + +Run Model Validation locally: +``` +npm install -g oav +oav validate-example +``` +Please see [readme](https://github.com/Azure/oav/blob/master/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/static-validation/static/errors/default) +Refer to [Semantic and Model Violations Reference](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Semantic-and-Model-Violations-Reference.md) for detailed description of validations and how-to-fix guidance. + +## Semantic Validation +Run Semantic Validation locally: +``` +npm install -g oav +oav validate-spec +``` +Please see [readme](https://github.com/Azure/oav/blob/master/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/static-validation/static/errors/default) +Refer to [Semantic and Model Violations Reference](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Semantic-and-Model-Violations-Reference.md) for detailed description of validations and how-to-fix guidance.