Update the version format check for canonical swagger

[dinwa-ms]

Lint rule description

For canonical swagger, the version info is "canonical", which violates the existing rule of the formate "Year-Month-Date". Can we make this a special case for canonical swagger?

There are some discussion about it in the channel

Related swagger example

{
"swagger": "2.0",
"info": {
"title": "Microsoft.Contoso management service",
"version": "canonical",
"description": "Microsoft.Contoso Resource Provider management API.",
"x-canonical-included-versions": [
"v2021_10_01_preview"
],
"x-typespec-generated": [
{
"emitter": "@azure-tools/typespec-autorest-canonical"
}
]
},
"schemes": [
"https"
],
...

Category

SDK

Severity level

Error

Applies to

Management plane API spec, Data plane API spec, RPaaS API spec

How to fix the violation

For canonical swagger, set the version to "canonical"; for versioned swagger, set the version to the specific version.

What't the impact if breaking the rule

The information will be misleading.

[dinwa-ms]

Could you help provide an update on this issue? Thanks

[mikeharder]

@rkmanda @bdefoy @tejaswiMinnu @AkhilaIlla: I believe this is an ARM-only rule:

azure-openapi-validator/packages/rulesets/src/spectral/az-arm.ts

Line 1066 in f3fcf47

APIVersionPattern: {

[dinwa-ms]

Hi @rkmanda @bdefoy @tejaswiMinnu @AkhilaIlla, may I ask is anyone working on this issue and is there any update or ETA on it? Thanks.

[dinwa-ms]

If it hasn't started, I can try to work on it and will share the code change for review.

[dinwa-ms]

Created PR for this issue
Update arm APIVersionPattern rule for canonical swagger #732