-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Added Api-Version 2017-07-01 for RecoveryServices.Backup Jobs #1502
Conversation
f781070
to
e46e012
Compare
Hi There, I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result: File: AutoRest Linter Guidelines | AutoRest Linter Issues Send feedback and make AutoRest Linter Azure Bot smarter day by day! Thanks for your co-operation. |
@@ -38,8 +40,9 @@ license-header: MICROSOFT_MIT | |||
|
|||
These settings apply only when `--tag=package-2016-12` is specified on the command line. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need to update the tag name to match below.
@@ -1107,101 +1104,6 @@ | |||
"deprecated": false | |||
} | |||
}, | |||
"/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this (and other) API removed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They are moved to new file jobs.json with new API version as current one were buggy for Python SDK and Azure CLI.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Buggy on which side, the swagger, REST endpoint (or both)? The removal will introduce breaking changes for clients using this API version. Usually the pattern here is to fix the APIs in a new version and deprecate the existing ones so that clients don't break and can migrate to the new ones.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It was buggy on service side which led to broken Python SDK. This change won't break any existing client code using REST APIs directly as old API version is still present in service. Also it won't be a breaking change for SDK users as only serialization of duration is changed in service code which is handled by generated SDKs internally.
And I don't see how keeping both API versions helps here, Autorest currently doesn't support multiple API versions for same API.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Autorest does support multiple API versions however today not all SDKs make them available (this is slowly changing).
Regardless there appears to be other breaking changes here as well, e.g. when I diff backupManagement.json and jobs.json I see a lot of removed operations. What happened to them?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jhendrixMSFT I don't get it. What other operations are removed? There are just 2 operations removed from backupManagement.json and both are added to jobs.json with new api version.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sigh you are right, I've been comparing the wrong stuff. :( Sorry for the noise I should have this wrapped up shortly.
Hi There, I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result: File: AutoRest Linter Guidelines | AutoRest Linter Issues Send feedback and make AutoRest Linter Azure Bot smarter day by day! Thanks for your co-operation. |
input-file: | ||
- Microsoft.RecoveryServices/2017-07-01/jobs.json | ||
- Microsoft.RecoveryServices/2016-12-01/backupManagement.json |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this swagger is being deleted then you need to remove it from the yaml.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Didn't understand this point either. Swagger is not deleted, only api version for 2 operations has been updated. Those two operations have been moved to jobs.json.
So as a whole number of operations are constant, just 2 operations have new api version.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My mistake, I didn't read close enough.
"type": "string" | ||
} | ||
}, | ||
"eTag": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The linter is complaining about this casing, see https://travis-ci.org/Azure/azure-rest-api-specs/jobs/260887527. I believe the casing should be "etag" and looking at other swaggers would appear to confirm.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is due to a bug introduced here Azure/autorest#2152 (comment) . A PR Azure/azure-openapi-validator#85 has been opened for fix in Autorest.
No modification for AutorestCI/azure-sdk-for-node |
…d balancer (#1528) * Updating documentation for Microsoft.VisualStudio with project resource APIs. Corrections to existing examples. (#1498) * Added Api-Version 2017-07-01 for RecoveryServices.Backup Jobs (#1502) * Added Api-Version 2017-07-01 for RecoveryServices.Backup Jobs * Updated tag names * Microsoft.Sql - Added data sync to package-2015-05-preview (#1510) * Added advisors and data sync to package-2015-05-preview * Removed advisors so current branch is only data sync * Make MsDeploy and MsDeployLog Azure resources (#1519) * Add public certificates, Functions Admin Token and MSDeploy APIs * Revert resource definition changes and description change for site properties * Make type and name readonly properties. Add ARM envelope to MSDeployStatus object * Fix missing quotation issue. * Add long running operation to MS deploy * Make MsDeploy and MsDeployLog Azure resources * Fix some AutoRest validation issues. Use dictionary for msdeploy.setparameters * Ensure models are same across all schemas in Microsoft.Web * Fix azure resource type across all models * Remove conflicting ListOperations. It is not used for public Azure. * no YAML in glob patterns for report scripts * Copying 2017-06-01 to 2017-08-01 * Changes for new API version * Updated script to run autorest with grouping swaggers based on config file (#1529) * Removed the maxLength for entities (#1527) * Update folder structure example. (#1489) Agreed on the changes * [Travis-ci] Oad in ci status (#1520) * Breaking change build should fail if result contains error Skipping newly added files Incorporating review feedback * testing * log the result as oad.compare returns promise for caller * Use published oad * Revert "testing" This reverts commit a9be94d. * Removed maxLength from entity name (#1531) * This is to add Cognitive Services data-plane API specs starting with Face API. (#1467) * Adding data plane spec starting with Face * Move Spec to right folder * Fixing validation issues. * Fixing issues and adding a readme.md * Fixing examples by removing decimals. * Removing another decimal value * Update readme.md * Updating spec based on comments. * Removing .gitignore. * Relay: Removed the maxLength for entity names (#1535)
…d balancer (#1528) (#1543) * Updating documentation for Microsoft.VisualStudio with project resource APIs. Corrections to existing examples. (#1498) * Added Api-Version 2017-07-01 for RecoveryServices.Backup Jobs (#1502) * Added Api-Version 2017-07-01 for RecoveryServices.Backup Jobs * Updated tag names * Microsoft.Sql - Added data sync to package-2015-05-preview (#1510) * Added advisors and data sync to package-2015-05-preview * Removed advisors so current branch is only data sync * Make MsDeploy and MsDeployLog Azure resources (#1519) * Add public certificates, Functions Admin Token and MSDeploy APIs * Revert resource definition changes and description change for site properties * Make type and name readonly properties. Add ARM envelope to MSDeployStatus object * Fix missing quotation issue. * Add long running operation to MS deploy * Make MsDeploy and MsDeployLog Azure resources * Fix some AutoRest validation issues. Use dictionary for msdeploy.setparameters * Ensure models are same across all schemas in Microsoft.Web * Fix azure resource type across all models * Remove conflicting ListOperations. It is not used for public Azure. * no YAML in glob patterns for report scripts * Copying 2017-06-01 to 2017-08-01 * Changes for new API version * Updated script to run autorest with grouping swaggers based on config file (#1529) * Removed the maxLength for entities (#1527) * Update folder structure example. (#1489) Agreed on the changes * [Travis-ci] Oad in ci status (#1520) * Breaking change build should fail if result contains error Skipping newly added files Incorporating review feedback * testing * log the result as oad.compare returns promise for caller * Use published oad * Revert "testing" This reverts commit a9be94d. * Removed maxLength from entity name (#1531) * This is to add Cognitive Services data-plane API specs starting with Face API. (#1467) * Adding data plane spec starting with Face * Move Spec to right folder * Fixing validation issues. * Fixing issues and adding a readme.md * Fixing examples by removing decimals. * Removing another decimal value * Update readme.md * Updating spec based on comments. * Removing .gitignore. * Relay: Removed the maxLength for entity names (#1535)
This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.
PR information
api-version
in the path should match theapi-version
in the spec).Quality of Swagger