Update databox.json

[ammaralavi]

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

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. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the 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 refresh required 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

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 label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

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

• 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

• Removing API(s) in a stable version
• Removing properties in a stable version
• Removing API version(s) in a stable version
• Updating API in a stable or public preview version with Breaking Change Validation errors
• Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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]

Hi, @ammaralavi 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-workflow-bot]

[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

[openapi-pipeline-app]

Swagger Validation Report

️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]

• Compared Swaggers (Based on Oad v0.9.0)
  • current:preview/2021-08-01-preview/databox.json compared with base:preview/2021-08-01-preview/databox.json

Rule	Message
❌ 1041 - AddedPropertyInResponse	The new version has a new property 'logCollectionLevel' in response that was not found in the old version. New: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L2708:7 Old: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L2708:7

️⚠️LintDiff: 0 Warnings warning [Detail]

• Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
  • databox/resource-manager/readme.md tag:package-2021-08-preview
• Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
  • databox/resource-manager/readme.md tag:package-2021-08-preview

The following errors/warnings exist before current PR submission:

Rule	Message
❌ R4009 - RequiredReadOnlySystemData	The property systemData in the response of operation:'Jobs_Get' is not read only. Please add the readonly for the systemData. Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L502
❌ R4009 - RequiredReadOnlySystemData	The property systemData in the response of operation:'Jobs_Create' is not read only. Please add the readonly for the systemData. Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L567
❌ R4009 - RequiredReadOnlySystemData	The property systemData in the response of operation:'Jobs_Update' is not read only. Please add the readonly for the systemData. Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L688
⚠️ R2057 - InvalidSkuModel	Sku Model definition 'Sku' is not valid. A Sku model must have 'name' property. It can also have 'tier', 'size', 'family', 'capacity' as optional properties. Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L4907
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isEnumerationInProgress Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L1725
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableManifestBackup Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L1883
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isPasskeyUserDefined Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L2433
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isCancellable Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L3526
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDeletable Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L3531
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isShippingAddressEditable Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L3536
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isPrepareToShipEnabled Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L3541
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isCancellableWithoutFee Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L3711
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isPerformedByCustomer Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L4152
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: sendNotification Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L4281
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L4313
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L5127
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: transferAllBlobs Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L5373
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: transferAllFiles Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L5377
⚠️ R4021 - DescriptionAndTitleMissing	'ApiError' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L1159
⚠️ R4021 - DescriptionAndTitleMissing	'Details' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L2896
⚠️ R4021 - DescriptionAndTitleMissing	'ErrorDetail' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L2978
⚠️ R4021 - DescriptionAndTitleMissing	'code' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L2903
⚠️ R4021 - DescriptionAndTitleMissing	'message' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L2906
⚠️ R4021 - DescriptionAndTitleMissing	'code' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L2985
⚠️ R4021 - DescriptionAndTitleMissing	'message' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L2988
⚠️ R4021 - DescriptionAndTitleMissing	'details' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L2991
⚠️ R4021 - DescriptionAndTitleMissing	'target' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DataBox/preview/2021-08-01-preview/databox.json#L2997

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

• The following tags are being changed in this PR
• databox/resource-manager/readme.md#package-2021-08-preview

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

Validation passes for PrettierCheck.

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

Validation passes for SpellCheck.

️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

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

[openapi-pipeline-app]

Swagger Generation Artifacts

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

Only 0 items are rendered, please refer to log for more details.

️❌[Staging] SDK Breaking Change Tracking failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️❌ azure-sdk-for-net failed [Detail]

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

️⚠️ azure-resource-manager-schemas warning [Detail]

Only 0 items are rendered, please refer to log for more details.

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

[openapi-workflow-bot]

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.

[ammaralavi]

@msyyc this new API version has been merged two days ago only, here is the PR to confirm
#15652

we forgot to add one property in a model, the API version hasn't been checked in ARM manifest, so we aren't affecting anybody as nobody has started using this version

need to get it quickly reviewed and merged so that we can continue with manifest checkin, since if we don't add this then our service will start giving many S360 KPI issues for this single property

[msyyc]

approve for python breaking change.

[openapi-workflow-bot]

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

[msyyc]

Hi @ammaralavi I can't merge it because of the CI error:

Please follow bot advice to fix it.

[ammaralavi]

Do I have to attend the office hours to get approval for breaking change or can I talk to someone quickly to get approval for this, I have created the following ADO item for this Scenario 11002427: Breaking change approval for adding field to a property in Azure DataBox version "2021-08-01-preview" - Boards (visualstudio.com)<https://msazure.visualstudio.com/One/_workitems/edit/11002427> From: msyyc ***@***.***> Sent: 24 September 2021 12:13 To: Azure/azure-rest-api-specs ***@***.***> Cc: Ammar Alavi ***@***.***>; Mention ***@***.***> Subject: Re: [Azure/azure-rest-api-specs] Update databox.json (#16144) Hi @ammaralavi<https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fammaralavi&data=04%7C01%7Cammaralavi%40microsoft.com%7C6e0f7b18824d4d78916a08d97f268a44%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637680625820295889%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=4%2BEikaxxwMJMCip00Km0cs%2BP4YpnjqZQzod4R%2FOK100%3D&reserved=0> I can't merge it because of the CI error: [Image removed by sender. image]<https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fuser-images.githubusercontent.com%2F70930885%2F134629864-031a1a67-1971-45f7-8cd9-904509f94d2a.png&data=04%7C01%7Cammaralavi%40microsoft.com%7C6e0f7b18824d4d78916a08d97f268a44%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637680625820295889%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=qf%2FgIufCp2vY671XPe9XxINYLllGR%2BW0zik%2FEc4rkZI%3D&reserved=0> Please follow bot advice<https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FAzure%2Fazure-rest-api-specs%2Fpull%2F16144%23issuecomment-926384371&data=04%7C01%7Cammaralavi%40microsoft.com%7C6e0f7b18824d4d78916a08d97f268a44%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637680625820305882%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=1icIn7J9YY2MaO32W2f5KiigY5WByz2QGV5sMt0F1cM%3D&reserved=0> to fix it. - You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FAzure%2Fazure-rest-api-specs%2Fpull%2F16144%23issuecomment-926385492&data=04%7C01%7Cammaralavi%40microsoft.com%7C6e0f7b18824d4d78916a08d97f268a44%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637680625820315879%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=m5a67P%2BEBMb94JFSf8T1BvE%2BD6kTYQvNr1TBh5fCv58%3D&reserved=0>, or unsubscribe<https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAVGHNRXBMNUHBZFRONISMVDUDQMW5ANCNFSM5EVC3NDQ&data=04%7C01%7Cammaralavi%40microsoft.com%7C6e0f7b18824d4d78916a08d97f268a44%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637680625820315879%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=DdmgL%2B0G4mzT7jywRoYyhVOehEPWZtyehNiw%2BHKKVXY%3D&reserved=0>. Triage notifications on the go with GitHub Mobile for iOS<https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fapps.apple.com%2Fapp%2Fapple-store%2Fid1477376905%3Fct%3Dnotification-email%26mt%3D8%26pt%3D524675&data=04%7C01%7Cammaralavi%40microsoft.com%7C6e0f7b18824d4d78916a08d97f268a44%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637680625820325873%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=RsVbO8WrgxDQKOZoXvQiBGwnN3e9OG6Tsl4RaGOTNgI%3D&reserved=0> or Android<https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fplay.google.com%2Fstore%2Fapps%2Fdetails%3Fid%3Dcom.github.android%26referrer%3Dutm_campaign%253Dnotification-email%2526utm_medium%253Demail%2526utm_source%253Dgithub&data=04%7C01%7Cammaralavi%40microsoft.com%7C6e0f7b18824d4d78916a08d97f268a44%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637680625820325873%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=4QUY8FMa4ELwl720TSXfUqyPSf5Dr0zBnrgj%2F5lx2yE%3D&reserved=0>.

[ammaralavi]

@msyyc Do I have to attend the office hours to get approval for breaking change or can I talk to someone quickly to get approval for this, I have created the following ADO item for this
https://msazure.visualstudio.com/One/_workitems/edit/11002427

[msyyc]

@ammaralavi You could try to send e-mail to @josefree ([email protected] ) for help. She is responsible for swagger breaking change

[ammaralavi]

@msyyc have got the Approved-BreakingChange tag, please go ahead and merge this PR