-
Notifications
You must be signed in to change notification settings - Fork 45
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
Update the version format check for canonical swagger #707
Comments
Could you help provide an update on this issue? Thanks |
@rkmanda @bdefoy @tejaswiMinnu @AkhilaIlla: I believe this is an ARM-only rule:
|
Hi @rkmanda @bdefoy @tejaswiMinnu @AkhilaIlla, may I ask is anyone working on this issue and is there any update or ETA on it? Thanks. |
If it hasn't started, I can try to work on it and will share the code change for review. |
Created PR for this issue |
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.
The text was updated successfully, but these errors were encountered: