azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Add new API version for databox 2022-10-01
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow. Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
- What's the purpose of the update?
- [ ] new service onboarding
- [x] new API version
- [ ] update existing version for new feature
- [ ] update existing version to fix swagger quality issue in s360
- [ ] Other, please clarify
- When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month. - January 2023
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. - January 2023
- By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
Contribution checklist (MS Employees Only):
- [x] I commit to follow the Breaking Change Policy of "no breaking changes"
- [x] I have reviewed the documentation for the workflow.
- [x] 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
Applicability: :warning:
If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.
- Change to data plane APIs
- Adding new properties
- All removals
Otherwise your PR may be subject to ARM review requirements. Complete the following:
-
[x] Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version -[x] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
-
[x] 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.
-
[x] 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.
Hi, @utsrkr Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 1 Errors, 1 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| databox.json | 2022-10-01(1e21dda) | 2022-09-01(main) |
| databox.json | 2022-10-01(1e21dda) | 2021-08-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
|
The 'required' status changed from the old version('True') to the new version('False'). New: Microsoft.DataBox/stable/2022-10-01/databox.json#L4783:7 Old: Microsoft.DataBox/stable/2022-09-01/databox.json#L4786:7 |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| :warning: 1025 - RequiredStatusChange | The 'required' status changed from the old version('True') to the new version('False'). New: Microsoft.DataBox/stable/2022-10-01/databox.json#L4783:7 Old: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L4203:7 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2022-10 | package-2022-10(1e21dda) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️️✔️~[Staging] CadlAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️❌SDK Breaking Change Tracking failed [Detail]
Breaking Changes Tracking
❌azure-sdk-for-go - sdk/resourcemanager/databox/armdatabox - Approved - 2.0.0+ Field `AccountName` of struct `DiskGranularCopyLogDetails` has been removed
❌azure-sdk-for-python-track2 - track2_azure-mgmt-databox - Approved - 1.0.0+ Model DataBoxDiskJobDetails no longer has parameter expected_data_size_in_terabytes + Model DataBoxHeavyJobDetails no longer has parameter expected_data_size_in_terabytes + Model DataBoxJobDetails no longer has parameter expected_data_size_in_terabytes + Model DiskScheduleAvailabilityRequest has a new required parameter expected_data_size_in_tera_bytes + Model DiskScheduleAvailabilityRequest no longer has parameter expected_data_size_in_terabytes + Model JobDetails no longer has parameter expected_data_size_in_terabytes
️❌ azure-sdk-for-net-track2 failed [Detail]
❌Failed [Logs]Release - Generate from dea4d453ca250eae677d69751d909df00d6b6b05. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json command pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:672 cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m 672 | [0m [36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s[0m … cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m | [31;1m ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1m[36;1m | [31;1mFailed to build sdk. exit code: False cmderr [Invoke-GenerateAndBuildV2.ps1] [0m
❌Azure.ResourceManager.DataBox [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] Breaking Changes: /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public System.Nullable<Azure.ResourceManager.DataBox.Models.TransportShipmentType> Azure.ResourceManager.DataBox.Models.DataBoxValidateAddressContent.TransportPreferencesPreferredShipmentType.get()' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/databox/Azure.ResourceManager.DataBox/src/Azure.ResourceManager.DataBox.csproj::TargetFramework=netstandard2.0], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public void Azure.ResourceManager.DataBox.Models.DataBoxValidateAddressContent.TransportPreferencesPreferredShipmentType.set(System.Nullable<Azure.ResourceManager.DataBox.Models.TransportShipmentType>)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/databox/Azure.ResourceManager.DataBox/src/Azure.ResourceManager.DataBox.csproj::TargetFramework=netstandard2.0], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public void Azure.ResourceManager.DataBox.Models.MitigateJobContent..ctor(Azure.ResourceManager.DataBox.Models.CustomerResolutionCode)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/databox/Azure.ResourceManager.DataBox/src/Azure.ResourceManager.DataBox.csproj::TargetFramework=netstandard2.0], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public Azure.ResourceManager.DataBox.Models.CustomerResolutionCode Azure.ResourceManager.DataBox.Models.MitigateJobContent.CustomerResolutionCode.get()' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/databox/Azure.ResourceManager.DataBox/src/Azure.ResourceManager.DataBox.csproj::TargetFramework=netstandard2.0], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(96,5): error : ApiCompat failed for '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/bin/Azure.ResourceManager.DataBox/Debug/netstandard2.0/Azure.ResourceManager.DataBox.dll' [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/databox/Azure.ResourceManager.DataBox/src/Azure.ResourceManager.DataBox.csproj::TargetFramework=netstandard2.0]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs]Release - Generate from dea4d453ca250eae677d69751d909df00d6b6b05. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json cmderr [automation_generate.sh] cmderr [automation_generate.sh] npm notice New major version of npm available! 8.19.3 -> 9.4.0 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.4.0> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-databox [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] ### Features Added info [Changelog] info [Changelog] - Added operation JobsOperations.mark_devices_shipped info [Changelog] - Added operation group DataBoxManagementClientOperationsMixin info [Changelog] - Model DataBoxDiskJobDetails has a new parameter actions info [Changelog] - Model DataBoxDiskJobDetails has a new parameter data_center_code info [Changelog] - Model DataBoxDiskJobDetails has a new parameter datacenter_address info [Changelog] - Model DataBoxDiskJobDetails has a new parameter device_erasure_details info [Changelog] - Model DataBoxDiskJobDetails has a new parameter expected_data_size_in_tera_bytes info [Changelog] - Model DataBoxDiskJobDetails has a new parameter granular_copy_log_details info [Changelog] - Model DataBoxDiskJobDetails has a new parameter granular_copy_progress info [Changelog] - Model DataBoxDiskJobDetails has a new parameter last_mitigation_action_on_job info [Changelog] - Model DataBoxDiskJobDetails has a new parameter reverse_shipping_details info [Changelog] - Model DataBoxHeavyJobDetails has a new parameter actions info [Changelog] - Model DataBoxHeavyJobDetails has a new parameter data_center_code info [Changelog] - Model DataBoxHeavyJobDetails has a new parameter datacenter_address info [Changelog] - Model DataBoxHeavyJobDetails has a new parameter device_erasure_details info [Changelog] - Model DataBoxHeavyJobDetails has a new parameter expected_data_size_in_tera_bytes info [Changelog] - Model DataBoxHeavyJobDetails has a new parameter last_mitigation_action_on_job info [Changelog] - Model DataBoxHeavyJobDetails has a new parameter reverse_shipping_details info [Changelog] - Model DataBoxJobDetails has a new parameter actions info [Changelog] - Model DataBoxJobDetails has a new parameter data_center_code info [Changelog] - Model DataBoxJobDetails has a new parameter datacenter_address info [Changelog] - Model DataBoxJobDetails has a new parameter device_erasure_details info [Changelog] - Model DataBoxJobDetails has a new parameter expected_data_size_in_tera_bytes info [Changelog] - Model DataBoxJobDetails has a new parameter last_mitigation_action_on_job info [Changelog] - Model DataBoxJobDetails has a new parameter reverse_shipping_details info [Changelog] - Model DataImportDetails has a new parameter log_collection_level info [Changelog] - Model JobDetails has a new parameter actions info [Changelog] - Model JobDetails has a new parameter data_center_code info [Changelog] - Model JobDetails has a new parameter datacenter_address info [Changelog] - Model JobDetails has a new parameter device_erasure_details info [Changelog] - Model JobDetails has a new parameter expected_data_size_in_tera_bytes info [Changelog] - Model JobDetails has a new parameter last_mitigation_action_on_job info [Changelog] - Model JobDetails has a new parameter reverse_shipping_details info [Changelog] - Model JobResource has a new parameter reverse_shipping_details_update info [Changelog] - Model JobResource has a new parameter reverse_transport_preference_update info [Changelog] - Model JobResource has a new parameter system_data info [Changelog] - Model Preferences has a new parameter reverse_transport_preferences info [Changelog] - Model Preferences has a new parameter storage_account_access_tier_preferences info [Changelog] - Model RegionConfigurationRequest has a new parameter datacenter_address_request info [Changelog] - Model RegionConfigurationResponse has a new parameter datacenter_address_response info [Changelog] - Model SkuInformation has a new parameter countries_within_commerce_boundary info [Changelog] - Model TransportPreferences has a new parameter is_updated info [Changelog] - Model UpdateJobDetails has a new parameter preferences info [Changelog] - Model UpdateJobDetails has a new parameter return_to_customer_package_details info [Changelog] - Model UpdateJobDetails has a new parameter reverse_shipping_details info [Changelog] info [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Model DataBoxDiskJobDetails no longer has parameter expected_data_size_in_terabytes info [Changelog] - Model DataBoxHeavyJobDetails no longer has parameter expected_data_size_in_terabytes info [Changelog] - Model DataBoxJobDetails no longer has parameter expected_data_size_in_terabytes info [Changelog] - Model DiskScheduleAvailabilityRequest has a new required parameter expected_data_size_in_tera_bytes info [Changelog] - Model DiskScheduleAvailabilityRequest no longer has parameter expected_data_size_in_terabytes info [Changelog] - Model JobDetails no longer has parameter expected_data_size_in_terabytes
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from dea4d453ca250eae677d69751d909df00d6b6b05. SDK Automation 14.0.0command sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json warn File azure-sdk-for-js_tmp/initOutput.json not found to read command sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
️✔️@azure/arm-databox [View full logs] [Release SDK Changes]info [Changelog] error breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from dea4d453ca250eae677d69751d909df00d6b6b05. SDK Automation 14.0.0command sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json command generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
️✔️sdk/resourcemanager/databox/armdatabox [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Field `AccountName` of struct `DiskGranularCopyLogDetails` has been removed info [Changelog] info [Changelog] ### Features Added info [Changelog] info [Changelog] - New type alias `ReverseShippingDetailsEditStatus` with values `ReverseShippingDetailsEditStatusDisabled`, `ReverseShippingDetailsEditStatusEnabled`, `ReverseShippingDetailsEditStatusNotSupported` info [Changelog] - New type alias `ReverseTransportPreferenceEditStatus` with values `ReverseTransportPreferenceEditStatusDisabled`, `ReverseTransportPreferenceEditStatusEnabled`, `ReverseTransportPreferenceEditStatusNotSupported` info [Changelog] - New struct `ContactInfo` info [Changelog] - New struct `ReverseShippingDetails` info [Changelog] - New field `ReverseShippingDetails` in struct `CommonJobDetails` info [Changelog] - New field `ReverseShippingDetails` in struct `CustomerDiskJobDetails` info [Changelog] - New field `AccountID` in struct `DiskGranularCopyLogDetails` info [Changelog] - New field `GranularCopyLogDetails` in struct `DiskJobDetails` info [Changelog] - New field `ReverseShippingDetails` in struct `DiskJobDetails` info [Changelog] - New field `ReverseShippingDetails` in struct `HeavyJobDetails` info [Changelog] - New field `ReverseShippingDetails` in struct `JobDetails` info [Changelog] - New field `ReverseShippingDetailsUpdate` in struct `JobProperties` info [Changelog] - New field `ReverseTransportPreferenceUpdate` in struct `JobProperties` info [Changelog] - New field `SerialNumberCustomerResolutionMap` in struct `MitigateJobRequest` info [Changelog] - New field `ReverseTransportPreferences` in struct `Preferences` info [Changelog] - New field `CountriesWithinCommerceBoundary` in struct `SKUProperties` info [Changelog] - New field `IsUpdated` in struct `TransportPreferences` info [Changelog] - New field `Preferences` in struct `UpdateJobDetails` info [Changelog] - New field `ReverseShippingDetails` in struct `UpdateJobDetails` info [Changelog] info [Changelog] Total 1 breaking change(s), 24 additive change(s).
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs]Release - Generate from dea4d453ca250eae677d69751d909df00d6b6b05. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json cmderr [init.sh] [notice] A new release of pip available: 22.3.1 -> 23.0 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] [notice] A new release of pip available: 22.3.1 -> 23.0 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
️✔️azure-resourcemanager-databox [View full logs] [Release SDK Changes]
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs]Release - Generate from dea4d453ca250eae677d69751d909df00d6b6b05. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json cmderr [initScript.sh] WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm, cmderr [initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry. cmderr [initScript.sh] npm WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient... cmderr [initScript.sh] npm WARN old lockfile warn File azure-resource-manager-schemas_tmp/initOutput.json not found to read command .sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
️✔️databox [View full logs] [Release Schema Changes]
️️✔️ azure-powershell succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from dea4d453ca250eae677d69751d909df00d6b6b05. SDK Automation 14.0.0command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json command pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
️✔️Az.DataBox [View full logs] [Release SDK Changes]
Thank you for your contribution utsrkr! We will review the pull request and get back to you soon.
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/databox/armdatabox | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
| Java | azure-resourcemanager-databox | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
| .Net | Azure.ResourceManager.DataBox | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
| JavaScript | @azure/arm-databox | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
Hi, @utsrkr your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).
Hi @utsrkr, 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. Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.
Hi, @utsrkr, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline
@utsrkr please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
@microsoft-github-policy-service agree [company="{your company}"]Options:
- (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
- (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
Contributor License Agreement
@microsoft-github-policy-service agree [company="Microsoft"]
@microsoft-github-policy-service agree company="your company"
@microsoft-github-policy-service agree company="Microsoft"
Hi, @utsrkr, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline
The initial commit is marked as "initial commit - copied files from previous api version"
Hi @utsrkr, 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. Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.
-
Some breaking changes mentioned in the validations have been approved in previous PRs: https://github.com/Azure/azure-rest-api-specs/pull/21625/checks?check_run_id=9635962268
-
In the mitigate job request, the field customer resolution code has been removed. The intake has been created and is waiting for review: https://msazure.visualstudio.com/One/_workitems/edit/16706852
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested
@utsrkr - I changed the label to get this PR off our radar until breaking change review is complete. When you are ready for ARM review, just remove the ARMChangesRequested label and the current oncall will pick up your PR for ARM review.
@utsrkr - I changed the label to get this PR off our radar until breaking change review is complete. When you are ready for ARM review, just remove the ARMChangesRequested label and the current oncall will pick up your PR for ARM review.
@mentat9 Looks like I don't have approval to add/remove labels. The breaking change review is complete. PR is now ready for ARM review.
"additionalProperties": {
ARM recommends against the use of the additionalProperties/empty/unschematized object pattern. ARM favors stronger typing wherever possible because it allows all consumers of your API to reason about it. This has benefits for everyone that interacts with your API including basic infrastructure, other Azure features, SDK owners, and customers. Unschematized objects are essentially API contracts that bypass Azure versioning infrastructure.
For example, customers will not be able to manage these objects using Azure Policy, or query them using ARG, both of which are standard Azure features. Customers expect to be able to use all common Azure features against all of their resources.
Generally, this pattern should only be used when needed and the object properties are dynamic, unknown, or user defined. Ref: https://armwiki.azurewebsites.net/api_contracts/guidelines/openapi.html#oapi032-only-use-additionalproperties-when-the-object-properties-are-dynamic-unknown-or-user-defined.
In this case, could you model the additionalProperties in an RPC-compliant way? Maybe an array of pairs (serial number and enum).
Refers to: specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/databox.json:4824 in be2d2a7. [](commit_id = be2d2a7975025e7da2a15ca2911175db181bf9cc, deletion_comment = False)
@mentat9 I had a discussion with my team regarding the comment on the PR to modify the ‘serialNumberCustomerResolutionMap’ in an RPC compliant way.
We fully agree with the points mentioned – that keeping it in the current format (in the form of a dictionary with additional properties) is not ideal. However, in our use case, we require a dictionary, since we want the serial number to be non-duplicated.
Also, currently our portal team has started using the API with the current contract. We fully agree that the contracts should have been reviewed before implementation and that this was an oversight on our part. However, currently, changing our contracts will lead to delay in our development cycle for the new feature and might lead to errors.
Considering the above points, will it be possible to go ahead with the swagger (and API) in its current format? If required, I can book some time during the ARM office hours to explain the scenario. Please let me know whatever suits your convenience.
"additionalProperties": {
It looks like I misread this property as being added to an existing resource type, but I see it is only in the request body of the mitigate action, so my concerns about Azure Policy and Azure Resource Graph don't apply.
In reply to: 1374353780
Refers to: specification/databox/resource-manager/Microsoft.DataBox/stable/2022-10-01/databox.json:4824 in be2d2a7. [](commit_id = be2d2a7975025e7da2a15ca2911175db181bf9cc, deletion_comment = False)
@msyyc @tadelesh Could you help take a look at the SDK breaking changes ? Thanks
The Go breaking change is from this PR (accountName change to accountId), but it seems not have been reviewed. @utsrkr Do you know any context about this breaking change?
Python breaking is not caused by this PR since the new api-version is not confiured in readme.python.md
@msyyc @tadelesh I missed the changes in the readme file, it was pointed out to me by a teammate. I have updated the PR with the changes in the readme file.
In that context, @msyyc you might want to review the 'Python-ApprovedBreakingChange' tag once more.
@tadelesh Let me get back to you regarding the change of parameter accountName to accountId.
@tadelesh The change that you mentioned is approved by the following work item: https://msazure.visualstudio.com/One/_workitems/edit/15890768