Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rule Update Request: Update to existing ApiVersionPattern rule to support canonical swagger #677

Open
allenjzhang opened this issue Apr 8, 2024 · 0 comments

Comments

@allenjzhang
Copy link
Member

allenjzhang commented Apr 8, 2024

Lint rule description

ARM has a new initiative that will generate a canonical version of swagger from TypeSpec which amalgamate all versions of models into a single swagger file under a new canonical folder which is at same level of stable and preview.

The version specified in this JSON is hard coded to canonical. The combination of canonical folder and API version being canonical should bypass this check.

Related swagger example

https://github.com/Azure/azure-rest-api-specs-pr/blob/db68ae0972e72e68bed18e657281495ebc0dfe79/specification/dinwadevtest/resource-manager/Microsoft.Contoso/canonical/openapi.json#L5

Category

ARM

Severity level

Error

Applies to

Management plane API spec

How to fix the violation

The combination of canonical folder and API version being canonical should bypass this check with date-time format.

What't the impact if breaking the rule

N/A

@konrad-jamrozik konrad-jamrozik changed the title Rule Update Request: Update to existing ApiVerionPattern rule to support canonical swagger Rule Update Request: Update to existing ApiVersionPattern rule to support canonical swagger May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 📋 Backlog
Development

No branches or pull requests

1 participant