Skip to content

SpotPlacementScore restructuring to RecommenderRP subdirectory - init…#36075

Merged
Elina-L merged 17 commits intoAzure:mainfrom
Elina-L:wenxliu/Part1SplitSpotPlacementScoreAPIIntoRecommenderRP
Jul 23, 2025
Merged

SpotPlacementScore restructuring to RecommenderRP subdirectory - init…#36075
Elina-L merged 17 commits intoAzure:mainfrom
Elina-L:wenxliu/Part1SplitSpotPlacementScoreAPIIntoRecommenderRP

Conversation

@Elina-L
Copy link
Member

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

…ial commit

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:
  • Moved SpotPlacementScore APIs to new RecommenderRP subdirectory under Microsoft.Compute - this is to split off Recommender APIs from Diagnostic APIs that our team owns.

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.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jul 21, 2025

Next Steps to Merge

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

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jul 21, 2025

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

@github-actions
Copy link

github-actions bot commented Jul 21, 2025

API Change Check

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

Language API Review for Package
Swagger Microsoft.Compute-RecommenderRP
Java com.azure.resourcemanager:azure-resourcemanager-compute-generated
JavaScript @azure/arm-compute

@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jul 21, 2025
…cementScore APIs, remove unref'd example files
@Elina-L
Copy link
Member Author

Elina-L commented Jul 21, 2025

This is the first in a three part PR series that aims to do the same as the following PR: #36039

I am breaking the PR linked above into three parts to make the PR more understandable and easy to review. I will work on and merge each PR in sequence.

PR order after discussion with Gary:
1. Move the (two) Spot Placement Score APIs to a new swagger file RecommenderRP.json under a new RecommenderRP subdirectory. Keep the API version as is: 2025-02-01-preview version
2. Add 2025-06-05 stable API version of the RecommenderRP.json swagger file in the RecommenderRP subdirectory
3. Add TypeSpec conversion of the swagger file in the 2025-06-05 stable API version subdirectory

- code: DefinitionsPropertiesNamesCamelCase
reason: The property name contains abbreviations and need to keep it as upper case.
from: RecommenderRP.json
- code: BodyTopLevelProperties
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add a where clause to indicate which property you are suppressing? Add more entries if there're multiple instances.

Copy link
Member Author

Choose a reason for hiding this comment

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

Removed BodyTopLevelProperties suppression

- code: OperationsAPIImplementation
reason: The operations API is defined in a separate file.
from: RecommenderRP.json
- code: PathForResourceAction
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add a where clause to indicate which property you are suppressing? Add more entries if there're multiple instances.

Copy link
Member Author

Choose a reason for hiding this comment

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

Added where clause

- code: PathForResourceAction
reason: This is not a valid scenario for the diskInspection and spotPlacementRecommender API as API Path does not match ARM Lint check formatting, requesting to suppress due to approval from reviewer.
from: RecommenderRP.json
- code: PathForNestedResource
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add a where clause to indicate which property you are suppressing? Add more entries if there're multiple instances.

Copy link
Member Author

Choose a reason for hiding this comment

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

Added where clause

@qiaozha
Copy link
Member

qiaozha commented Jul 22, 2025

Add suppression for avocado as MULTIPLE_API_VERSION issue has already been aware by compute team.

@gary-x-li gary-x-li added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jul 22, 2025
@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 22, 2025
@gary-x-li gary-x-li added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required Approved-Suppression and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jul 22, 2025
@Elina-L Elina-L enabled auto-merge (squash) July 22, 2025 03:22
@Elina-L Elina-L added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Jul 22, 2025
@Elina-L Elina-L requested a review from gary-x-li July 22, 2025 03:36
@tadelesh
Copy link
Member

/azp run SDK Validation - Go

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@Elina-L Elina-L merged commit a539c8d into Azure:main Jul 23, 2025
44 of 46 checks passed
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.

7 participants

Comments