Skip to content

Commit

Permalink
Added example gneration document links (#14151)
Browse files Browse the repository at this point in the history
  • Loading branch information
raych1 authored Apr 28, 2021
1 parent 146cc17 commit 0070175
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
6 changes: 5 additions & 1 deletion documentation/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?<a name="Onboard"></a>
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)
Expand Down Expand Up @@ -37,5 +38,8 @@ If you are working in the private repository, please refer to this [document](ht
## How to generate Document from Swagger?<a name="doc"></a>
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?<a name="examplegen"></a>
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?<a name="contact"></a>
If any other help need, Please send a mail to vscswagger@microsoft.com
3 changes: 2 additions & 1 deletion documentation/ci-fix.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,9 @@ npm install -g oav
oav validate-example <swagger-spec-path>
```
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:
Expand Down

0 comments on commit 0070175

Please sign in to comment.