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

Fix the api descrption

Open fangru2023 opened this issue 1 year ago • 4 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.
  • [ ] 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).
  • [x] Other, please clarify:
    • Change the documentation in of APIs

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.

fangru2023 avatar Oct 23 '24 17:10 fangru2023

Next Steps to Merge

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

Please fix the required ModelValidation errors too.

ramoka178 avatar Oct 23 '24 23:10 ramoka178

Please fix the required ModelValidation errors too.

Fixed, thanks for reminder.

fangru2023 avatar Oct 29 '24 23:10 fangru2023

Please fix the required ModelValidation errors too.

Fixed, thanks for reminder.

Hi @ramoka178 , any change needed from our side?

fangru2023 avatar Nov 06 '24 18:11 fangru2023

Hi @qiaozha , would you mind help with this PR? We are waiting for JS breaking change review for several business days.

fangru2023 avatar Nov 15 '24 00:11 fangru2023

approved for js, thanks

qiaozha avatar Nov 15 '24 02:11 qiaozha

/azp run

fangru2023 avatar Nov 18 '24 18:11 fangru2023

Azure Pipelines successfully started running 3 pipeline(s).

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

Hi @kazrael2119, thanks for adding the suppression.yml file, we are wondering what does this use for and we saw there is a line of - Enum KnownRefillPolicy no longer has value Always, actually for our StandbyContainerGroupPool RefillPolicy should be Always

fangru2023 avatar Nov 18 '24 18:11 fangru2023

API change check

APIView has identified API level changes in this PR and created following API reviews.

Microsoft.StandbyPool Microsoft.StandbyPool

azure-sdk avatar Dec 16 '24 18:12 azure-sdk

/azp run

fangru2023 avatar Jan 10 '25 19:01 fangru2023

Azure Pipelines successfully started running 4 pipeline(s).

azure-pipelines[bot] avatar Jan 10 '25 19:01 azure-pipelines[bot]