Skip to content

Conversation

Elina-L
Copy link
Member

@Elina-L Elina-L commented Jul 7, 2025

…ion to 2025-06-05

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).
  • 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:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • 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.
  • A release plan has been created. If not, please create one as it will help guide you through the REST API and SDK creation process.

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.
  • For guidance on SDK breaking change review, refer to https://aka.ms/ci-fix.

Copy link

openapi-pipeline-app bot commented Jul 7, 2025

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This PR targets either the main branch of the public specs repo or the RPSaaSMaster branch of the private specs repo. These branches are not intended for iterative development. Therefore, you must acknowledge you understand that after this PR is merged, the APIs are considered shipped to Azure customers. Any further attempts at in-place modifications to the APIs will be subject to Azure's versioning and breaking change policies. Additionally, for control plane APIs, you must acknowledge that you are following all the best practices documented by ARM at aka.ms/armapibestpractices. If you do intend to release the APIs to your customers by merging this PR, add the PublishToCustomers label to your PR in acknowledgement of the above. Otherwise, retarget this PR onto a feature branch, i.e. with prefix release- (see aka.ms/azsdk/api-versions#release--branches).
  • ❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
    This PR has ARMChangesRequested label. Please address or respond to feedback from the ARM API reviewer.
    When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
    Automation should then add WaitForARMFeedback label.
    ❗If you don't have permissions to remove the label, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories.
    For details of the ARM review, see aka.ms/azsdk/pr-arm-review
  • ❌ The required check named Automated merging requirements met has failed. This is the final check that must pass. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide. In addition, refer to step 4 in the PR workflow diagram

Copy link

openapi-pipeline-app bot commented Jul 7, 2025

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview new-api-version resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jul 7, 2025
Copy link

github-actions bot commented Jul 7, 2025

API Change Check

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

Language API Review for Package
Java com.azure.resourcemanager:azure-resourcemanager-compute-generated

@Elina-L Elina-L changed the title Initial commit - copying diagnostic file from 2025-02-01-preview vers… Adding 2025-06-05 stable version for ComputeRP SpotPlacementScore APIs Jul 7, 2025
@Elina-L
Copy link
Member Author

Elina-L commented Jul 9, 2025

Note: this PR is based off a previous PR created in May that had already been approved: #34340

The previous PR was approved but never merged and closed due to inactivity. I created a new PR with additional comments from this PR created last week: #35560

@razvanbadea-msft
Copy link
Member

Note: this PR is based off a previous PR created in May that had already been approved: #34340

The previous PR was approved but never merged and closed due to inactivity. I created a new PR with additional comments from this PR created last week: #35560

what is the reason you created a new one as i see the #35560 is open with the same files modified.

Why did you set to v3 in place of v5?

@razvanbadea-msft
Copy link
Member

Check the error from swagger avocado. The input files is from multiple versions instead of one

@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 10, 2025
@Elina-L
Copy link
Member Author

Elina-L commented Jul 10, 2025

Note: this PR is based off a previous PR created in May that had already been approved: #34340
The previous PR was approved but never merged and closed due to inactivity. I created a new PR with additional comments from this PR created last week: #35560

what is the reason you created a new one as i see the #35560 is open with the same files modified.

Why did you set to v3 in place of v5?

I created a new PR as per guidance from the reviewer in the last PR:

There are multiple APIs in previous preview version that are missed here

https://github.com/Azure/azure-rest-api-specs/blob/main/specification/compute/resource-manager/Microsoft.Compute/DiagnosticRP/preview/2025-02-01-preview/diagnostic.json

Make the first commit to be the exact copy of old apiversion files , but in the new folder of the new apiversion.
From the second commit, make the changes you need on these copied files, starting from updating the apiversion string and any other new APIs etc.

I set it to v3 instead of v5 as I was getting duplicate schema errors preventing merge, and after setting it to v3 those duplicate schema errors were resolved

@Elina-L
Copy link
Member Author

Elina-L commented Jul 10, 2025

@chintanrp chintanrp added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 10, 2025
@AzureRestAPISpecReview AzureRestAPISpecReview removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 10, 2025
@chintanrp chintanrp added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 11, 2025
@razvanbadea-msft
Copy link
Member

Check the error from swagger avocado. The input files is from multiple versions instead of one

@grizzlytheodore said that this swagger error can be ignored: https://teams.microsoft.com/l/message/19:0351f5f9404446e4b4fd4eaf2c27448d@thread.skype/1752094514960?tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47&groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&parentMessageId=1752094514960&teamName=Azure%20SDK&channelName=API%20Spec%20Review&createdTime=1752094514960

more like to be suppressed for now but i do not see a confirmation about it in that thread

@razvanbadea-msft
Copy link
Member

Note: this PR is based off a previous PR created in May that had already been approved: #34340
The previous PR was approved but never merged and closed due to inactivity. I created a new PR with additional comments from this PR created last week: #35560

what is the reason you created a new one as i see the #35560 is open with the same files modified.
Why did you set to v3 in place of v5?

I created a new PR as per guidance from the reviewer in the last PR:

There are multiple APIs in previous preview version that are missed here
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/compute/resource-manager/Microsoft.Compute/DiagnosticRP/preview/2025-02-01-preview/diagnostic.json
Make the first commit to be the exact copy of old apiversion files , but in the new folder of the new apiversion.
From the second commit, make the changes you need on these copied files, starting from updating the apiversion string and any other new APIs etc.

I set it to v3 instead of v5 as I was getting duplicate schema errors preventing merge, and after setting it to v3 those duplicate schema errors were resolved

for what schema, it could be that you have some definitions that are added also in common-types in v5, and in that case you can remove yours

@razvanbadea-msft razvanbadea-msft removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 11, 2025
Copy link
Member

@qiaozha qiaozha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check out the email "Need you help on the version uniform issue in Compute services"

These settings apply only when `--tag=package-2025-06-05` is specified on the command line.

``` yaml $(tag) == "package-2025-06-05"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other APIs are all generated from TypeSpec,
I don't think we should add a new manual written swagger into the tag. Please consider split it into an independent service.
/cc @JeffreyRichter

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since Compute has transitioned to TypeSpec and committed to maintaining API specifications using TypeSpec, adding new manually authored Swagger files is strictly prohibited. Please ensure to submit Typespec of DiagnosticRP and swagger generated from TypeSpec. Or you will get blocked when releasing SDKs.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have created a new PR to split the Microsoft.Compute DiagnosticRP to a new SDK, and renamed it to RecommenderRP to align with future plans of also splitting off a subset of recommendations specific APIs from diagnostic specific APIs,

PR: https://github.com/Azure/azure-rest-api-specs/pull/35994/files

@Elina-L Elina-L requested a review from qiaozha July 15, 2025 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants