Azure / Azure/azure-sdk-tools

Swagger APIView integrate with swagger validation tools

Open
#3,484 0 comments 0 reactions 1 assignee Claimed by @ruowan View on GitHub
APIView Central-EngSys Swagger
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

We have serval swagger validation tools like oav, lint. These validation tools already integrate with our swagger unified pipeline in spec repo https://github.com/Azure/azure-rest-api-specs.

Here are our validation tools repos link.

- https://github.com/Azure/oav
- https://github.com/Azure/azure-openapi-validator

__Goal__: To provider a better swagger review user experience, we need to integrate swagger validation tool with swagger APIView. User can directly see the issues detected in swagger files.

I guess there are two approaches to integrate swagger APIView with lint validation tools. One is lint validation tool report errors with json path and build mapping between swagger APIView format and original swagger file, another is reimplement some critical lint rules directly in swagger APIView token parser.

We need to think about a compatiable way to integrate validation tools in swagger APIView.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.