Merging new apiversion 2023-05-01-preview Changes to main
Merging new apiversion 2023-05-01-preview Changes to main
ARM (Control Plane) API Specification Update Pull Request
[!TIP] Overwhelmed by all this guidance? See the
Getting helpsection 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.
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 PRandDue diligence checklist. - If you don't have permissions to remove or add labels to the PR, request
write accessper 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 Mergecomment. 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
queuedstate, please add a comment with contents/azp run. This should result in a new comment denoting aPR validation pipelinehas 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.
Next Steps to Merge
✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/connectedcache/armconnectedcache | https://apiview.dev/Assemblies/Review/475d61f32a4e4236b3ff3ffa1105edc2?revisionId=ae59094ec4f547618de2c9db180261d4 |
| Swagger | Microsoft.ConnectedCache | https://apiview.dev/Assemblies/Review/c193e39454f04a65819821e70619a467?revisionId=6056c4a9deb24e1891f24500420bc730 |
| TypeSpec | ConnectedCache.Management | https://apiview.dev/Assemblies/Review/5a50ea191e6e4557ae6029019adb47cf?revisionId=ace4c85baa8543faa915eb7129ea6236 |
As per API spec review the swagger ModelValidations are known.looking sugestion from apireview team for workaround or fixes.
/azp run
Azure Pipelines successfully started running 3 pipeline(s).
Can you please take a look at the warnings in the lintdiff and fix as appropriate : https://github.com/Azure/azure-rest-api-specs/pull/30870/checks?check_run_id=31199438783
[bharathi] this got fixed after the branch is updated with latest changes.
Is this an RPaaS rp and has this PR already been reviewed in the private repo ?
yes this was approved deployed and tested in private repo.
here is the private repro approved changes : https://github.com/Azure/azure-rest-api-specs-pr/pull/19106
This PR is first attempt to move the changes to main branch for next steps.
Can you please take a look at the warnings in the lintdiff and fix as appropriate : https://github.com/Azure/azure-rest-api-specs/pull/30870/checks?check_run_id=31199438783
[bharathi] this got fixed after the branch is updated with latest changes.
[bharathi] also at this point we are not planning on changing boolean to enum as these need lot of changes in our userrp as it supports multiple flavors . we already considered this for new properties added recently. but will need to keep all old properties as is.
@Bharam-Msft - Signing off for ARM, based on the signoff from the private repo. Can you confirm whether the suppressions are still required and remove them if not needed?
PublishToCustomers
@Bharam-Msft - Signing off for ARM, based on the signoff from the private repo. Can you confirm whether the suppressions are still required and remove them if not needed?
i have removed supression link and i see the next comment as suppression added for autorest config. we are working on SDK generation and that the reason we need to be in main to work on generating SDks. our api verison has preview in it, may be for this supression is required?