Skip to content
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

Changes in shippingAddress and encryptionPreferences as a part of S360 #23332

Merged
merged 6 commits into from
Apr 1, 2023

Conversation

truptishet
Copy link
Contributor

@truptishet truptishet commented Mar 28, 2023

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:

  1. 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
  2. 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.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. 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):

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

ARM API Review Checklist

Applicability: ⚠️

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:

  • 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
      -[ ] 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.
  • 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 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.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Mar 28, 2023

Swagger Validation Report

️❌BreakingChange: 6 Errors, 0 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
databox.json 2022-12-01(b538ac7) 2022-12-01(main)
Rule Message
1041 - AddedPropertyInResponse The new version has a new property 'skipAddressValidation' in response that was not found in the old version.
New: Microsoft.DataBox/stable/2022-12-01/databox.json#L5689:7
Old: Microsoft.DataBox/stable/2022-12-01/databox.json#L5667:7
1041 - AddedPropertyInResponse The new version has a new property 'taxIdentificationNumber' in response that was not found in the old version.
New: Microsoft.DataBox/stable/2022-12-01/databox.json#L5689:7
Old: Microsoft.DataBox/stable/2022-12-01/databox.json#L5667:7
1041 - AddedPropertyInResponse The new version has a new property 'hardwareEncryption' in response that was not found in the old version.
New: Microsoft.DataBox/stable/2022-12-01/databox.json#L3562:7
Old: Microsoft.DataBox/stable/2022-12-01/databox.json#L3562:7
1045 - AddedOptionalProperty The new version has a new optional property 'skipAddressValidation' that was not found in the old version.
New: Microsoft.DataBox/stable/2022-12-01/databox.json#L5689:7
Old: Microsoft.DataBox/stable/2022-12-01/databox.json#L5667:7
1045 - AddedOptionalProperty The new version has a new optional property 'taxIdentificationNumber' that was not found in the old version.
New: Microsoft.DataBox/stable/2022-12-01/databox.json#L5689:7
Old: Microsoft.DataBox/stable/2022-12-01/databox.json#L5667:7
1045 - AddedOptionalProperty The new version has a new optional property 'hardwareEncryption' that was not found in the old version.
New: Microsoft.DataBox/stable/2022-12-01/databox.json#L3562:7
Old: Microsoft.DataBox/stable/2022-12-01/databox.json#L3562:7
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) new version base version
package-2022-12 package-2022-12(b538ac7) package-2022-12(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L5754


The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule Message
ParametersOrder The parameters:jobName,resourceGroupName should be kept in the same order as they present in the path.
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L113
ParametersOrder The parameters:jobName,resourceGroupName should be kept in the same order as they present in the path.
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L167
CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L567
CreateOperationAsyncResponseValidation An async PUT operation must return 201.
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L602
CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L609
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L609
DeleteOperationAsyncResponseValidation An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options'
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L638
PatchSkuProperty The patch operation body parameter schema should contains property 'sku'.
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L725
ConsistentPatchProperties The property 'properties.details.returnToCustomerPackageDetails' in the request body either not apppear in the resource model or has the wrong level.
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L730
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L1084
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L1160
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L1299
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L1383
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L1395
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L1446
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L2257
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L2291
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L2979
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L3030
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L3100
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L3124
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L3149
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L3162
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L3185
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L3209
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L3248
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L3261
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L3378
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L3385
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.DataBox/stable/2022-12-01/databox.json#L3623
️️✔️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.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView 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.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

Hi, @truptishet 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. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 28, 2023

    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 - 2.0.0
    +	Field `AccountName` of struct `DiskGranularCopyLogDetails` has been removed
    azure-sdk-for-python-track2 - track2_azure-mgmt-databox - 2.0.0b1
    +	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 56ec6a3. SDK Automation 14.0.0
      command	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:671
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 671 | �[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 Detected
      info	[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.DataBoxOrderPreferences.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.DataBoxOrderPreferences.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 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 56ec6a3. 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] 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] npm notice
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.0 -> 9.6.3
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.3>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.3` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-databox [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation JobsOperations.mark_devices_shipped
      info	[Changelog]   - Added operation group DataBoxManagementClientOperationsMixin
      info	[Changelog]   - Model CopyProgress has a new parameter actions
      info	[Changelog]   - Model CopyProgress has a new parameter error
      info	[Changelog]   - Model DataBoxDiskCopyProgress has a new parameter actions
      info	[Changelog]   - Model DataBoxDiskCopyProgress has a new parameter error
      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 EncryptionPreferences has a new parameter hardware_encryption
      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 ShippingAddress has a new parameter skip_address_validation
      info	[Changelog]   - Model ShippingAddress has a new parameter tax_identification_number
      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 56ec6a3. SDK Automation 14.0.0
      command	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 56ec6a3. SDK Automation 14.0.0
      command	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 Detected
      info	[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 enum type `HardwareEncryption` with values `HardwareEncryptionDisabled`, `HardwareEncryptionEnabled`
      info	[Changelog] - New enum type `ReverseShippingDetailsEditStatus` with values `ReverseShippingDetailsEditStatusDisabled`, `ReverseShippingDetailsEditStatusEnabled`, `ReverseShippingDetailsEditStatusNotSupported`
      info	[Changelog] - New enum type `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 `Actions` in struct `CopyProgress`
      info	[Changelog] - New field `Error` in struct `CopyProgress`
      info	[Changelog] - New field `Actions` in struct `CustomerDiskCopyProgress`
      info	[Changelog] - New field `Error` in struct `CustomerDiskCopyProgress`
      info	[Changelog] - New field `ReverseShippingDetails` in struct `CustomerDiskJobDetails`
      info	[Changelog] - New field `Actions` in struct `DiskCopyProgress`
      info	[Changelog] - New field `Error` in struct `DiskCopyProgress`
      info	[Changelog] - New field `AccountID` in struct `DiskGranularCopyLogDetails`
      info	[Changelog] - New field `Actions` in struct `DiskGranularCopyProgress`
      info	[Changelog] - New field `Error` in struct `DiskGranularCopyProgress`
      info	[Changelog] - New field `GranularCopyLogDetails` in struct `DiskJobDetails`
      info	[Changelog] - New field `ReverseShippingDetails` in struct `DiskJobDetails`
      info	[Changelog] - New field `HardwareEncryption` in struct `EncryptionPreferences`
      info	[Changelog] - New field `Actions` in struct `GranularCopyProgress`
      info	[Changelog] - New field `Error` in struct `GranularCopyProgress`
      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 `SkipAddressValidation` in struct `ShippingAddress`
      info	[Changelog] - New field `TaxIdentificationNumber` in struct `ShippingAddress`
      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), 34 additive change(s).
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 56ec6a3. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh]
      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 56ec6a3. SDK Automation 14.0.0
      command	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.DefaultTag [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 28, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/databox/armdatabox https://apiview.dev/Assemblies/Review/ca747869435741b09107dae35261c7df
    Java azure-resourcemanager-databox https://apiview.dev/Assemblies/Review/6c55801b2d814a73ac31025ab3d7c34c
    .Net Azure.ResourceManager.DataBox https://apiview.dev/Assemblies/Review/3a751f265fc14ad18862a1f554116b36
    JavaScript @azure/arm-databox https://apiview.dev/Assemblies/Review/c6d4ba78e3ff4d7c8e23b01c8cc3449f

    @openapi-workflow-bot
    Copy link

    Hi @truptishet, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @MaryGao
    Copy link
    Member

    MaryGao commented Mar 29, 2023

    Hi @truptishet, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    Task How to fix Priority
    Avocado Fix-Avocado High
    Semantic validation Fix-SemanticValidation-Error High
    Model validation Fix-ModelValidation-Error High
    LintDiff Fix-LintDiff high
    If you need further help, please feedback via swagger feedback.

    @truptishet Could you fix the failure?

    @truptishet truptishet changed the title Changes in get call Changes in shippingAddress object as a part of S360 Mar 29, 2023
    @openapi-workflow-bot
    Copy link

    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.

    @MaryGao
    Copy link
    Member

    MaryGao commented Mar 29, 2023

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @MaryGao MaryGao added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Mar 29, 2023
    @openapi-workflow-bot
    Copy link

    Hi @truptishet, 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.

    @MaryGao MaryGao removed NewApiVersionRequired BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels Mar 29, 2023
    Copy link
    Member

    @MaryGao MaryGao left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Since the breaking in Python and Go is not introduced by this pr. I will approve it directly.

    @MaryGao MaryGao self-requested a review March 30, 2023 04:49
    @MaryGao MaryGao added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Mar 30, 2023
    @truptishet truptishet changed the title Changes in shippingAddress object as a part of S360 Changes in shippingAddress and encryptionPreferences as a part of S360 Mar 30, 2023
    @AzureRestAPISpecReview AzureRestAPISpecReview added NewApiVersionRequired and removed BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels Mar 30, 2023
    @mikekistler mikekistler added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Mar 31, 2023
    @MaryGao MaryGao merged commit 56ec6a3 into main Apr 1, 2023
    @MaryGao MaryGao deleted the tshet/FieldsInGetJobCall branch April 1, 2023 12:05
    JoshLove-msft pushed a commit to JoshLove-msft/azure-rest-api-specs that referenced this pull request Apr 25, 2023
    Azure#23332)
    
    * Changes in get call
    
    * Changes in get call
    
    * Changes in get call
    
    * Changes
    
    * Hardware encryption changes
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 CI-BreakingChange-Go FixS360 NewApiVersionRequired resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants