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.

Sign up for GitHub

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

Jump to bottom

added new API version in preview, new SKU named Customer Disk, new API for the SKU and additional models required for new SKU #15652

Merged
merged 17 commits into from
Sep 22, 2021
Merged

added new API version in preview, new SKU named Customer Disk, new API for the SKU and additional models required for new SKU #15652

merged 17 commits into from
Sep 22, 2021

Conversation

ammaralavi
Copy link
Contributor

@ammaralavi ammaralavi commented Aug 15, 2021 •
edited
Loading

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:

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
Copy link

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
    Copy link

    [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
    Copy link

    openapi-pipeline-app bot commented Aug 15, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️⚠️LintDiff: 1 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ 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


    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#L4884
    ⚠️ 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: 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#L3503
    ⚠️ 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#L3508
    ⚠️ 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#L3513
    ⚠️ 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#L3518
    ⚠️ 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#L3688
    ⚠️ 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#L4129
    ⚠️ 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#L4258
    ⚠️ 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#L4290
    ⚠️ 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#L5104
    ⚠️ 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#L5350
    ⚠️ 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#L5354
    ⚠️ 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#L2873
    ⚠️ 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#L2955
    ⚠️ 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#L2880
    ⚠️ 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#L2883
    ⚠️ 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#L2962
    ⚠️ 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#L2965
    ⚠️ 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#L2968
    ⚠️ 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#L2974
    ️️✔️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

    ️️✔️[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
    Copy link

    openapi-pipeline-app bot commented Aug 15, 2021 •
    edited
    Loading

    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 openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 15, 2021
    @openapi-workflow-bot
    Copy link

    Hi, @ammaralavi your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

    This was referenced Aug 15, 2021
    Closed
    Draft
    This was referenced Aug 15, 2021
    Closed
    Closed
    Closed
    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @msyyc
    Copy link
    Member

    msyyc commented Aug 16, 2021

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Aug 16, 2021
    Closed
    @ammaralavi
    Copy link
    Contributor Author

    @msyyc @pilor can you please review this PR and merge it on an urgent basis

    @msyyc
    Copy link
    Member

    msyyc commented Sep 17, 2021

    Hi @ArcturusZhang Please check breaking change for GO.

    @jhendrixMSFT jhendrixMSFT added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Sep 20, 2021
    @ammaralavi
    Copy link
    Contributor Author

    @msyyc are there any more approvals left? if not then can you please merge this.

    @msyyc msyyc merged commit 8d11eed into Azure:main Sep 22, 2021
    This was referenced Sep 22, 2021
    Closed
    Merged
    Closed
    Closed
    Closed
    ghost pushed a commit to Azure/azure-resource-manager-schemas that referenced this pull request Sep 22, 2021
    [ReleasePR databox] added new API version in preview, new SKU named C…
    6647def 
    …ustomer Disk, new API for the SKU and additional models required for new SKU (#1926)

Create to sync Azure/azure-rest-api-specs#15652
[ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...AzureSDKAutomation:sdkAuto/databox?expand=1)
    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Sep 22, 2021
    Closed
    @ammaralavi ammaralavi mentioned this pull request Sep 24, 2021
    Merged
    25 tasks
    Hardell pushed a commit to Hardell/azure-rest-api-specs that referenced this pull request Sep 27, 2021
    @ammaralavi
    added new API version in preview, new SKU named Customer Disk, new AP…
    ea44771 
    …I for the SKU and additional models required for new SKU (Azure#15652)

* initial commit

* added new API version in preview, new SKU, new API for the SKU and additional models required for new SKU

* resolved some errors

* Update readme.go.md

* Update MarkDevicesShipped.json

* Update MarkDevicesShipped.json

* Update cSpell.json

* Update databox.json

* Update databox.json

* updated databox.json

* Update databox.json

* Update MarkDevicesShipped.json

* Update databox.json

* Update databox.json

* Update databox.json

* Update databox.json

* resolved comments
    LeiWang3 pushed a commit to LeiWang3/azure-rest-api-specs that referenced this pull request Mar 31, 2022
    @ammaralavi @LeiWang3
    added new API version in preview, new SKU named Customer Disk, new AP…
    0efc33a 
    …I for the SKU and additional models required for new SKU (Azure#15652)

* initial commit

* added new API version in preview, new SKU, new API for the SKU and additional models required for new SKU

* resolved some errors

* Update readme.go.md

* Update MarkDevicesShipped.json

* Update MarkDevicesShipped.json

* Update cSpell.json

* Update databox.json

* Update databox.json

* updated databox.json

* Update databox.json

* Update MarkDevicesShipped.json

* Update databox.json

* Update databox.json

* Update databox.json

* Update databox.json

* resolved comments
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @lirenhe lirenhe lirenhe approved these changes

    @00Kai0 00Kai0 Awaiting requested review from 00Kai0

    @ArcturusZhang ArcturusZhang Awaiting requested review from ArcturusZhang

    @jsntcy jsntcy Awaiting requested review from jsntcy jsntcy is a code owner

    @msyyc msyyc Awaiting requested review from msyyc msyyc is a code owner

    @qiaozha qiaozha Awaiting requested review from qiaozha qiaozha is a code owner

    @RAY-316 RAY-316 Awaiting requested review from RAY-316

    @pilor pilor Awaiting requested review from pilor

    Assignees

    @msyyc msyyc

    Labels
    Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go Approved-SdkBreakingChange-Python ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    5 participants
    @ammaralavi @msyyc @lirenhe @pilor @jhendrixMSFT