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

Addition of new datacenter codes to databox rest-api-specs preview file #17279

Merged
merged 2 commits into from
Jan 28, 2022

Conversation

urguru
Copy link
Contributor

@urguru urguru commented Jan 7, 2022

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?
    • Other, please clarify - Addition of newly added DataCenterCodes to the Databox Rest API Specs
  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.
    It is already live
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
    This change does not need a swagger update
  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, @urguru 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 Jan 7, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.

    ️⚠️LintDiff: 0 Warnings warning [Detail]
    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#L4919
    ⚠️ 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#L3538
    ⚠️ 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#L3543
    ⚠️ 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#L3548
    ⚠️ 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#L3553
    ⚠️ 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#L3723
    ⚠️ 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#L4164
    ⚠️ 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#L4293
    ⚠️ 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#L4325
    ⚠️ 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#L5139
    ⚠️ 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#L5385
    ⚠️ 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#L5389
    ⚠️ 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.
    ️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️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.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    ️️✔️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).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 7, 2022

    Swagger Generation Artifacts

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

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

    ️❌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 warning [Detail]

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

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

    @urguru urguru changed the title Added new datacenter codes to databox rest-api-specs preview repo Addition of new datacenter codes to databox rest-api-specs preview file Jan 7, 2022
    @changlong-liu changlong-liu merged commit 31e3d74 into Azure:main Jan 28, 2022
    @urguru urguru deleted the guruprasadv/DataBoxNewDCEnumAddition branch January 28, 2022 11:59
    mstrisoline pushed a commit to mstrisoline/azure-rest-api-specs that referenced this pull request Feb 1, 2022
    …le (Azure#17279)
    
    * Added new datacenter codes to databox rest-api-specs preview repo
    
    * Removed YQB20 from the new additions
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    None yet
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants