diff --git a/documentation/FAQ.md b/documentation/FAQ.md index 82cd2276edec..2e05573323f8 100644 --- a/documentation/FAQ.md +++ b/documentation/FAQ.md @@ -6,7 +6,8 @@ This page is intended to answer questions frequently asked during Azure Swagger 2. [How to fix validation failure?](#validation) 3. [How to generate SDK from Swagger?](#SDK) 4. [How to generate document](#doc) -5. [If need further help, who can we contact?](#contact) +5. [How to generate swagger examples](#examplegen) +6. [If need further help, who can we contact?](#contact) ## How to onboard PR review Process? If you are new to Swagger/OpenAPI, you can refer to this [document](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/80/Getting-started-with-OpenAPI-specifications) @@ -37,5 +38,8 @@ If you are working in the private repository, please refer to this [document](ht ## How to generate Document from Swagger? Refer to [document](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/79/Generation-of-docs-on-docs.microsoft.com) +## How to generate examples from Swagger? +Refer to [Swagger-Example-Generation](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/393/Swagger-Example-Generation) + ## If need further help, who can we contact? If any other help need, Please send a mail to vscswagger@microsoft.com \ No newline at end of file diff --git a/documentation/ci-fix.md b/documentation/ci-fix.md index 32901b31f3e4..5380826c32c4 100644 --- a/documentation/ci-fix.md +++ b/documentation/ci-fix.md @@ -34,8 +34,9 @@ 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) +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. +Refer to [Swagger-Example-Generation](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/393/Swagger-Example-Generation) for example automatic generation. ## Semantic Validation Run Semantic Validation locally: