azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

Sync with RPSaaSMaster for versions 2024-08-01-preview and 2024-10-01-preview

Open v-xuezhan opened this issue 1 year ago • 2 comments

ARM (Control Plane) API Specification Update Pull Request

[!TIP] Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • [ ] New resource provider.
  • [X] New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • [ ] Update existing version to fix OpenAPI spec quality issues in S360.
  • [ ] Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • [ ] Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood and followed the instructions by checking all the boxes:

  • [X] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • [X] I have reviewed following Resource Provider guidelines, including ARM resource provider contract and REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run. This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

v-xuezhan avatar Oct 16 '24 17:10 v-xuezhan

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

You have a few warnings introduced in the new properties for using booleans here : https://github.com/Azure/azure-rest-api-specs/pull/31058/checks?check_run_id=32233178833

Can you please review and update those to enum since ARM recommends enums over booleans. More details here : https://github.com/Azure/azure-openapi-validator/blob/main/docs/enum-instead-of-boolean.md

raosuhas avatar Nov 07 '24 06:11 raosuhas

This is the PR to syncup with RPSaaSMaster: https://github.com/Azure/azure-rest-api-specs-pr/pull/19700(this one got the approval and merged already)

The suggestion of changing boolean to Enum had been discussed and decision has been made by leadership team. Evan from MSFT approved the above PR: I attached the screenshot of the conversation for your reference. Screenshot 2024-10-23 at 8 36 15 AM Screenshot 2024-10-23 at 8 37 25 AM

v-xuezhan avatar Nov 07 '24 20:11 v-xuezhan

/azp run

v-maksymm avatar Nov 19 '24 17:11 v-maksymm

Azure Pipelines successfully started running 3 pipeline(s).

azure-pipelines[bot] avatar Nov 19 '24 17:11 azure-pipelines[bot]