Fix v5 sdk errors and update swagger #12480

ericshape · 2021-01-19T04:31:32Z

This PR contains changes to address the v5 SDK validation errors.
https://github.com/Azure/azure-rest-api-specs/pull/12107/checks?check_run_id=1765298546
### All the breaking changes are expected.

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No, no need to refresh for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of “no breaking changes
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
- Adding new API(s)
- Adding a new API version
- Adding a new service
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable version with Breaking Change Validation errors
Updating API(s) in preview over 1 year

### None of any of them. Add paths to address the validation errors which I listed at the beginning of the description.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2021-01-19T04:31:35Z

Hi, @ericshape Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

openapi-pipeline-app · 2021-01-19T04:31:35Z

Swagger Validation Report

️❌BreakingChange: 3 Errors, 3 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.8.6)
- original: preview/2020-08-01-preview/DataWarehouseUserActivities.json <---> new: preview/2020-08-01-preview/DataWarehouseUserActivities.json
- original: preview/2020-08-01-preview/DatabaseOperations.json <---> new: preview/2020-08-01-preview/DatabaseOperations.json
- original: preview/2020-08-01-preview/DatabaseUsages.json <---> new: preview/2020-08-01-preview/DatabaseUsages.json
- original: preview/2020-08-01-preview/ManagedDatabaseTransparentDataEncryption.json <---> new: preview/2020-08-01-preview/ManagedDatabaseTransparentDataEncryption.json
- original: preview/2020-08-01-preview/ManagedInstanceAzureADOnlyAuthentications.json <---> new: preview/2020-08-01-preview/ManagedInstanceAzureADOnlyAuthentications.json
- original: preview/2020-08-01-preview/RestorableDroppedDatabases.json <---> new: preview/2020-08-01-preview/RestorableDroppedDatabases.json
- original: preview/2020-08-01-preview/ServerAzureADOnlyAuthentications.json <---> new: preview/2020-08-01-preview/ServerAzureADOnlyAuthentications.json
- original: preview/2020-08-01-preview/TransparentDataEncryptions.json <---> new: preview/2020-08-01-preview/TransparentDataEncryptions.json

Rule	Message
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.Sql/preview/2020-08-01-preview/DataWarehouseUserActivities.json#L75:5
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.Sql/preview/2020-08-01-preview/ManagedDatabaseTransparentDataEncryption.json#L160:5
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.Sql/preview/2020-08-01-preview/TransparentDataEncryptions.json#L163:5
⚠️ 1032 - DifferentAllOf	The new version has a different 'allOf' property than the previous one. New: Microsoft.Sql/preview/2020-08-01-preview/RestorableDroppedDatabases.json#L115:11 Old: Microsoft.Sql/preview/2020-08-01-preview/RestorableDroppedDatabases.json#L115:11
⚠️ 1032 - DifferentAllOf	The new version has a different 'allOf' property than the previous one. New: Microsoft.Sql/preview/2020-08-01-preview/RestorableDroppedDatabases.json#L91:13 Old: Microsoft.Sql/preview/2020-08-01-preview/RestorableDroppedDatabases.json#L91:13
⚠️ 1032 - DifferentAllOf	The new version has a different 'allOf' property than the previous one. New: Microsoft.Sql/preview/2020-08-01-preview/RestorableDroppedDatabases.json#L167:5 Old: Microsoft.Sql/preview/2020-08-01-preview/RestorableDroppedDatabases.json#L167:5

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

Linted configuring files (Based on source branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
- sql/resource-manager/readme.md tag:default
Linted configuring files (Based on target branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
- sql/resource-manager/readme.md tag:default

️⚠️Avocado: 1 Warnings warning [Detail]

Rule	Message
⚠️ MULTIPLE_API_VERSION	The default tag contains multiple API versions swaggers. readme: specification/sql/resource-manager/readme.md tag: specification/sql/resource-manager/readme.md#tag-package-composite-v4

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2021-01-19T04:31:36Z

Swagger Generation Artifacts

️⚠️ azure-sdk-for-python warning [Detail]

⚠️Warning [Logs]Release - Generate from 600fe4a. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] Ignoring mock: markers 'python_version <= "2.7"' don't match your environment
cmderr	[automation_init.sh]   Failed building wheel for ConfigArgParse
cmderr	[automation_init.sh]   Failed building wheel for yarl
cmderr	[automation_init.sh]   Failed building wheel for wrapt
cmderr	[automation_init.sh]   Failed building wheel for multidict
cmderr	[automation_init.sh] Cannot uninstall requirement azure-nspkg, not installed
cmderr	[automation_init.sh] Command '['/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/bin/python', '-m', 'pip', 'uninstall', '-y', 'azure-nspkg']' returned non-zero exit status 1.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

️✔️azure-mgmt-sql [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation ServersOperations.import_database
info	[Changelog]   - Added operation group ImportExportOperations
info	[Changelog]
info	[Changelog] **Breaking changes**
info	[Changelog]
info	[Changelog]   - Removed operation DatabasesOperations.import_method
info	[Changelog]   - Removed operation DatabasesOperations.import_database

️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 600fe4a. Schema Automation 14.0.0

warn	Skip initScript due to not configured
command	npx n 12
command	autorest --use=@autorest/[email protected] --version=3.0.6369 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/sql/resource-manager/readme.md
cmdout	[Autorest] WARNING: Found duplicate definition for type Microsoft.Sql/servers/firewallRules in scope ResourceGroup

️✔️sql [View full logs] [Release Schema Changes]

cmderr	[resource-manager] node-pre-gyp
cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
cmderr	[resource-manager] WARN [email protected] No repository field.
cmderr	[resource-manager] npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/fsevents):
cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs]Release - Generate from 600fe4a. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
cmderr	[generate.py] 2021-01-29 03:14:30 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-sql-generated"
cmderr	[generate.py] 2021-01-29 03:14:30 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
cmderr	[generate.py] 2021-01-29 03:14:30 INFO autorest --version=3.0.6350 --use=@autorest/[email protected] --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/sql/azure-resourcemanager-sql-generated --java.namespace=com.azure.resourcemanager.sql.generated   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/sql/resource-manager/readme.md
cmderr	[generate.py] 2021-01-29 03:17:32 INFO [CI][Success] Write to ci.yml
cmderr	[generate.py] 2021-01-29 03:17:32 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2021-01-29 03:17:32 INFO [POM][Skip] pom already has module azure-resourcemanager-sql-generated
cmderr	[generate.py] 2021-01-29 03:17:32 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2021-01-29 03:17:32 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2021-01-29 03:17:32 INFO [POM][Success] Write to root pom
cmderr	[generate.py] WARNING: An illegal reflective access operation has occurred
cmderr	[generate.py] WARNING: Illegal reflective access by org.codehaus.groovy.reflection.ReflectionUtils (file:/home/vsts/.m2/repository/org/codehaus/groovy/groovy/3.0.0-beta-2/groovy-3.0.0-beta-2-indy.jar) to method java.util.Collections$UnmodifiableCollection.toString()
cmderr	[generate.py] WARNING: Please consider reporting this to the maintainers of org.codehaus.groovy.reflection.ReflectionUtils
cmderr	[generate.py] WARNING: Use --illegal-access=warn to enable warnings of further illegal reflective access operations
cmderr	[generate.py] WARNING: All illegal access operations will be denied in a future release

️✔️azure-resourcemanager-sql-generated [View full logs] [Release SDK Changes]

cmderr	[Inst] 2021-01-29 03:22:33 DEBUG Got artifact_id: azure-resourcemanager-sql-generated
cmderr	[Inst] 2021-01-29 03:22:33 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2021-01-29 03:22:33 DEBUG Got artifact: azure-resourcemanager-sql-generated-1.0.0-beta.1-javadoc.jar
cmderr	[Inst] 2021-01-29 03:22:33 DEBUG Got artifact: azure-resourcemanager-sql-generated-1.0.0-beta.1.jar
cmderr	[Inst] 2021-01-29 03:22:33 DEBUG Match jar package: azure-resourcemanager-sql-generated-1.0.0-beta.1.jar
cmderr	[Inst] 2021-01-29 03:22:33 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/12480/azure-sdk-for-java/azure-resourcemanager-sql-generated/azure-resourcemanager-sql-generated-1.0.0-beta.1.jar\" -o azure-resourcemanager-sql-generated-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-sql-generated -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-sql-generated-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
```"}

️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 600fe4a. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-5.0
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/sql/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied

️✔️Microsoft.Azure.Management.Sql [View full logs] [Release SDK Changes]
- Microsoft.Azure.Management.Sql.1.49.0-preview.nupkg
- Microsoft.Azure.Management.Sql.1.49.0-preview.snupkg

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 600fe4a. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/sql/resource-manager/readme.md

️✔️@azure/arm-sql [View full logs] [Release SDK Changes]

azure-arm-sql-7.0.2.tgz

cmderr	[npmPack] loaded rollup.config.js with warnings
cmderr	[npmPack] (!) Unused external imports
cmderr	[npmPack] default imported from external module 'rollup' but never used
cmderr	[npmPack] ./esm/sqlManagementClient.js → ./dist/arm-sql.js...
cmderr	[npmPack] created ./dist/arm-sql.js in 2s

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 600fe4a. SDK Automation 14.0.0

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️sql/mgmt/2014-04-01/sql [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```

️✔️preview/sql/mgmt/v3.0/sql [View full logs] [Release SDK Changes] Breaking Change Detected

Only show 20 items here, please refer to log for details.

info	[Changelog] - New function `TopQueries.MarshalJSON() ([]byte, error)`
info	[Changelog] - New function `ManagedInstancesClient.ListByManagedInstanceResponder(*http.Response) (TopQueriesListResult, error)`
info	[Changelog] - New function `ManagedInstancesClient.ListByManagedInstance(context.Context, string, string, *int32, string, string, string, QueryTimeGrainType, AggregationFunctionType, MetricType) (TopQueriesListResultPage, error)`
info	[Changelog] - New function `NewTopQueriesListResultPage(TopQueriesListResult, func(context.Context, TopQueriesListResult) (TopQueriesListResult, error)) TopQueriesListResultPage`
info	[Changelog] - New struct `ManagedInstancePecProperty`
info	[Changelog] - New struct `ManagedInstancePrivateEndpointConnectionProperties`
info	[Changelog] - New struct `ManagedInstancePrivateEndpointProperty`
info	[Changelog] - New struct `QueryMetricInterval`
info	[Changelog] - New struct `QueryMetricProperties`
info	[Changelog] - New struct `QueryStatisticsProperties`
info	[Changelog] - New struct `TopQueries`
info	[Changelog] - New struct `TopQueriesListResult`
info	[Changelog] - New struct `TopQueriesListResultIterator`
info	[Changelog] - New struct `TopQueriesListResultPage`
info	[Changelog] - New field `PrivateEndpointConnections` in struct `ManagedInstanceProperties`
info	[Changelog] - New field `ZoneRedundant` in struct `ManagedInstanceProperties`
info	[Changelog] - New field `Identity` in struct `ManagedInstanceUpdate`
info	[Changelog]
info	[Changelog] Total 20 breaking change(s), 70 additive change(s).
info	[Changelog]

️✔️preview/sql/mgmt/2018-06-01-preview/sql [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Const `None` type has been changed from `SensitivityLabelRank` to `IdentityType`
info	[Changelog] - Const `High` has been removed
info	[Changelog] - Const `Medium` has been removed
info	[Changelog] - Const `Low` has been removed
info	[Changelog] - Const `Critical` has been removed
info	[Changelog]
info	[Changelog] ### New Content
info	[Changelog]
info	[Changelog] - New const `SensitivityLabelRankLow`
info	[Changelog] - New const `SensitivityLabelRankMedium`
info	[Changelog] - New const `SensitivityLabelRankCritical`
info	[Changelog] - New const `SensitivityLabelRankNone`
info	[Changelog] - New const `UserAssigned`
info	[Changelog] - New const `SensitivityLabelRankHigh`
info	[Changelog]
info	[Changelog] Total 5 breaking change(s), 6 additive change(s).
info	[Changelog]

️✔️preview/sql/mgmt/2017-10-01-preview/sql [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```

️✔️preview/sql/mgmt/2017-03-01-preview/sql [View full logs] [Release SDK Changes] Breaking Change Detected

Only show 20 items here, please refer to log for details.

info	[Changelog] - Const `UnitDefinitionTypeSeconds` has been removed
info	[Changelog] - Const `Average` has been removed
info	[Changelog]
info	[Changelog] ### New Content
info	[Changelog]
info	[Changelog] - New const `UserAssigned`
info	[Changelog] - New const `Percent`
info	[Changelog] - New const `Bytes`
info	[Changelog] - New const `BytesPerSecond`
info	[Changelog] - New const `PrimaryAggregationTypeNone`
info	[Changelog] - New const `PrimaryAggregationTypeMaximum`
info	[Changelog] - New const `PrimaryAggregationTypeCount`
info	[Changelog] - New const `PrimaryAggregationTypeMinimum`
info	[Changelog] - New const `PrimaryAggregationTypeTotal`
info	[Changelog] - New const `CountPerSecond`
info	[Changelog] - New const `PrimaryAggregationTypeAverage`
info	[Changelog] - New const `Seconds`
info	[Changelog]
info	[Changelog] Total 12 breaking change(s), 12 additive change(s).
info	[Changelog]

️✔️preview/sql/mgmt/2015-05-01-preview/sql [View full logs] [Release SDK Changes] Breaking Change Detected

Only show 20 items here, please refer to log for details.

info	[Changelog] - Const `UnitDefinitionTypeCount` has been removed
info	[Changelog] - Const `UnitDefinitionTypeCountPerSecond` has been removed
info	[Changelog]
info	[Changelog] ### New Content
info	[Changelog]
info	[Changelog] - New const `PrimaryAggregationTypeTotal`
info	[Changelog] - New const `Percent`
info	[Changelog] - New const `PrimaryAggregationTypeAverage`
info	[Changelog] - New const `Bytes`
info	[Changelog] - New const `PrimaryAggregationTypeNone`
info	[Changelog] - New const `BytesPerSecond`
info	[Changelog] - New const `CountPerSecond`
info	[Changelog] - New const `PrimaryAggregationTypeMinimum`
info	[Changelog] - New const `UserAssigned`
info	[Changelog] - New const `PrimaryAggregationTypeMaximum`
info	[Changelog] - New const `PrimaryAggregationTypeCount`
info	[Changelog] - New const `Seconds`
info	[Changelog]
info	[Changelog] Total 12 breaking change(s), 12 additive change(s).
info	[Changelog]

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2021-01-19T04:34:37Z

Hi @ericshape, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

openapi-workflow-bot · 2021-01-19T04:34:37Z

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

ericshape · 2021-01-23T03:29:42Z

@jianyexi
I don't fully understand this validation error:

❌ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'tags' renamed or removed?New: Microsoft.Sql/preview/2020-08-01-preview/RestorableDroppedDatabases.json#L175:7Old: Microsoft.Sql/preview/2020-08-01-preview/RestorableDroppedDatabases.json#L178:7

it seems there is no tags in the old one. Can you give me a hint about it? Thanks!

@xaliciayang @akning-ms

jianyexi · 2021-01-25T02:31:12Z

@ericshape Actually it's inside the reference :

azure-rest-api-specs/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/RestorableDroppedDatabases.json

Line 175 in fc163b1

"$ref": "../../../common/v1/types.json#/definitions/TrackedResource"

ericshape · 2021-01-25T02:38:38Z

@ericshape Actually it's inside the reference :

azure-rest-api-specs/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/RestorableDroppedDatabases.json

Line 175 in fc163b1

"$ref": "../../../common/v1/types.json#/definitions/TrackedResource"

Thanks!
it seems proxyResource don't have tags.

…specs into fix_v5_sdk_errors_2

ericshape · 2021-01-26T00:33:48Z

Rule	Message
❌ 1038 - AddedPath	The new version is adding a path that was not found in the old version.New: Microsoft.Sql/preview/2020-08-01-preview/DataWarehouseUserActivities.json#L75:5
❌ 1038 - AddedPath	The new version is adding a path that was not found in the old version.New: Microsoft.Sql/preview/2020-08-01-preview/ManagedDatabaseTransparentDataEncryption.json#L160:5
❌ 1038 - AddedPath	The new version is adding a path that was not found in the old version.New: Microsoft.Sql/preview/2020-08-01-preview/TransparentDataEncryptions.json#L163:5

these breaking changes are expected 'cause the LIST operations are added to pass the validation in:
https://github.com/Azure/azure-rest-api-specs/pull/12107/checks?check_run_id=1765298546
❌ R4015 - NestedResourcesMustHaveListOperation

ericshape · 2021-01-27T03:01:33Z

@filizt @jorgecotillo can you give ARM feedback? Thanks!
This PR addresses some lint errors in https://github.com/Azure/azure-rest-api-specs/pull/12107/checks?check_run_id=1765298546. The breaking changes are expected and explained in the comment above.

ericshape · 2021-01-28T21:09:16Z

@pilor I have sent an email to you for a review request about this PR

pilor · 2021-01-28T22:19:35Z

A PR flagged with breaking changes needs to go through the breaking change process outlined in the PR description. Once you get approval there we can move forward.

ericshape · 2021-01-28T22:38:39Z

A PR flagged with breaking changes needs to go through the breaking change process outlined in the PR description. Once you get approval there we can move forward.

Hi @pilor @akning-ms
The breaking changes (adding new paths) were to address the validation errors in https://github.com/Azure/azure-rest-api-specs/pull/12107/checks?check_run_id=1765298546.
For this goal, do we also need to go through the long breaking change review process? https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/37684/Breaking-Changes
It would cost a lot of overheads. Why did we need it?

We are pressured to release v5 SDK in #12107 which is behind the schedule.

pilor · 2021-01-28T22:48:44Z

A PR flagged with breaking changes needs to go through the breaking change process outlined in the PR description. Once you get approval there we can move forward.

Hi @pilor @akning-ms
The breaking changes (adding new paths) were to address the validation errors in https://github.com/Azure/azure-rest-api-specs/pull/12107/checks?check_run_id=1765298546.
For this goal, do we also need to go through the long breaking change review process? https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/37684/Breaking-Changes
It would cost a lot of overheads! Why did we need it?

We are pressured to release v5 SDK in #12107 which is behind the schedule.

You are making changes to an api-version that already exists in Microsoft.SQL's prod manifest. That is exactly what the breaking change process is designed to cover. This also shouldn't count as a preview API in my opinion as SQL has been using preview APIs as their main API versions since 2015.

pilor

Approving due to the breaking change s360 bypass

ericshape · 2021-01-28T23:24:51Z

Approving due to the breaking change s360 bypass

@pilor Thank you very much!

* update v5 sdk errors * update RestorableDroppedDatabases.json

update v5 sdk errors

f47641b

ericshape changed the title ~~update v5 sdk errors~~ fix v5 sdk errors and update swagger Jan 19, 2021

ericshape changed the title ~~fix v5 sdk errors and update swagger~~ Fix v5 sdk errors and update swagger Jan 19, 2021

openapi-pipeline-app bot added BreakingChangeReviewRequired labels Jan 19, 2021

This was referenced Jan 19, 2021

[AutoPR azure-mgmt-sql] Fix v5 sdk errors and update swagger AzureSDKAutomation/azure-sdk-for-python#3751

Closed

[AutoPR @azure/arm-sql] Fix v5 sdk errors and update swagger AzureSDKAutomation/azure-sdk-for-js#3252

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Go label Jan 19, 2021

ericshape closed this Jan 25, 2021

ericshape reopened this Jan 25, 2021

openapi-pipeline-app bot removed the CI-BreakingChange-Go label Jan 25, 2021

Merge branch 'master' of https://github.com/ericshape/azure-rest-api-…

a9a2bdf

…specs into fix_v5_sdk_errors_2

openapi-pipeline-app bot added CI-BreakingChange-Python CI-BreakingChange-Go and removed BreakingChangeReviewRequired labels Jan 25, 2021

update RestorableDroppedDatabases.json

0cc4eaa

ericshape marked this pull request as ready for review January 26, 2021 01:49

ericshape requested a review from bcham as a code owner January 26, 2021 01:49

bcham approved these changes Jan 26, 2021

View reviewed changes

jianyexi approved these changes Jan 27, 2021

View reviewed changes

jianyexi closed this Jan 27, 2021

jianyexi reopened this Jan 27, 2021

openapi-workflow-bot bot added the FixS360 label Jan 28, 2021

pilor self-requested a review January 28, 2021 23:17

pilor added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jan 28, 2021

pilor approved these changes Jan 28, 2021

View reviewed changes

akning-ms removed the NewApiVersionRequired label Jan 29, 2021

akning-ms merged commit 600fe4a into Azure:master Jan 29, 2021

mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021

Fix v5 sdk errors and update swagger (Azure#12480)

c3f68e1

* update v5 sdk errors * update RestorableDroppedDatabases.json

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix v5 sdk errors and update swagger #12480

Fix v5 sdk errors and update swagger #12480

ericshape commented Jan 19, 2021 •

edited

Loading

openapi-workflow-bot bot commented Jan 19, 2021

openapi-pipeline-app bot commented Jan 19, 2021 •

edited

Loading

openapi-pipeline-app bot commented Jan 19, 2021 •

edited

Loading

openapi-workflow-bot bot commented Jan 19, 2021

openapi-workflow-bot bot commented Jan 19, 2021

ericshape commented Jan 23, 2021

jianyexi commented Jan 25, 2021

ericshape commented Jan 25, 2021 •

edited

Loading

ericshape commented Jan 26, 2021 •

edited

Loading

ericshape commented Jan 27, 2021

ericshape commented Jan 28, 2021

pilor commented Jan 28, 2021

ericshape commented Jan 28, 2021 •

edited

Loading

pilor commented Jan 28, 2021

pilor left a comment

ericshape commented Jan 28, 2021

Fix v5 sdk errors and update swagger #12480

Fix v5 sdk errors and update swagger #12480

Conversation

ericshape commented Jan 19, 2021 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Jan 19, 2021

openapi-pipeline-app bot commented Jan 19, 2021 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jan 19, 2021 • edited Loading

Swagger Generation Artifacts

openapi-workflow-bot bot commented Jan 19, 2021

openapi-workflow-bot bot commented Jan 19, 2021

ericshape commented Jan 23, 2021

jianyexi commented Jan 25, 2021

ericshape commented Jan 25, 2021 • edited Loading

ericshape commented Jan 26, 2021 • edited Loading

ericshape commented Jan 27, 2021

ericshape commented Jan 28, 2021

pilor commented Jan 28, 2021

ericshape commented Jan 28, 2021 • edited Loading

pilor commented Jan 28, 2021

pilor left a comment

Choose a reason for hiding this comment

ericshape commented Jan 28, 2021

ericshape commented Jan 19, 2021 •

edited

Loading

openapi-pipeline-app bot commented Jan 19, 2021 •

edited

Loading

openapi-pipeline-app bot commented Jan 19, 2021 •

edited

Loading

ericshape commented Jan 25, 2021 •

edited

Loading

ericshape commented Jan 26, 2021 •

edited

Loading

ericshape commented Jan 28, 2021 •

edited

Loading