Skip to content

Conversation

@Elina-L
Copy link
Member

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

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.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jul 17, 2025

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
    ❗❗❗ ARM review workflow label is missing! ❗❗❗TO UNBLOCK THIS PR, add /azp run comment to this PR to allow automation to determine where this PR is in the ARM review workflow.
    For details of the ARM review, see aka.ms/azsdk/pr-arm-review
  • ❌ The suppressions added to the AutoRest config files (README.mds) require review. Refer to step 1 in the PR workflow diagram, or to step 3, depending on the kind of suppression you did.
  • ❌ 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

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jul 17, 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 17, 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
JavaScript @azure/arm-compute
TypeSpec Microsoft.Compute
Go sdk/resourcemanager/compute/armcompute
Python azure-mgmt-compute

@grizzlytheodore grizzlytheodore added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Jul 17, 2025
@AzureRestAPISpecReview AzureRestAPISpecReview added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed CI-RpaaSRPNotInPrivateRepo RPaaS NotReadyForARMReview labels Jul 17, 2025
@Elina-L Elina-L changed the title Splitting RecommenderRP to individual package, initial commit Splitting RecommenderRP to individual package, API version 2025-06-05 stable Jul 17, 2025
@qiaozha
Copy link
Member

qiaozha commented Jul 18, 2025

@mikeharder do you know why the Swagger ModelValidation check and Swagger BreakingChange is reporting errors that are unrelated to this PR even unrelated to the specification/compute folder? thanks.

@mikeharder
Copy link
Member

mikeharder commented Jul 18, 2025

@mikeharder do you know why the Swagger ModelValidation check and Swagger BreakingChange is reporting errors that are unrelated to this PR even unrelated to the specification/compute folder? thanks.

@qiaozha: The source branch of this PR has a strange set of merges, that are confusing git into thinking more files are changed. Rebase or squash the source branch on latest main and force push to fix.

@mikeharder
Copy link
Member

@Elina-L: The source branch of this PR has a strange set of merges, that are confusing git into thinking more files are changed. Rebase or squash the source branch on latest main and force push to fix.

@Elina-L Elina-L force-pushed the wenxliu/SplitDiagnosticRPToIndividualPackage branch from 8bf8974 to 63ec7de Compare July 18, 2025 06:32
@Elina-L Elina-L requested a review from weshaggard as a code owner July 18, 2025 06:32
Comment on lines +7 to +13
"@azure-tools/typespec-autorest":
use-read-only-status-schema: true
omit-unreachable-types: true
emitter-output-dir: "{project-root}"
azure-resource-provider-folder: "resource-manager"
output-file: "{version-status}/{version}/RecommenderRP.json"
examples-dir: "{project-root}/examples"
Copy link
Member

Choose a reason for hiding this comment

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

This is folder structure v2, you can follow this config here https://github.com/Azure/azure-rest-api-specs/blob/main/specification/widget/resource-manager/Microsoft.Widget/Widget/tspconfig.yaml#L9-L13 to resolve the common-types reference path issue. Which is also why you see the semantic validation error.

@pshao25 it seems the converter tool need to update for this.

service-name: "Widget" # human-readable service name, whitespace allowed
flavor: azure
"@azure-tools/typespec-ts":
package-dir: "arm-widget"
Copy link
Member

Choose a reason for hiding this comment

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

We are not going to call the service name widget, please come up with a name that makes sense.

- tool: TypeSpecRequirement
path: DiagnosticRP/preview/2025-02-01-preview/**/*.json
reason: CDRP service not yet ready to migrate to typespec
- tool: TypeSpecRequirement
Copy link
Member

Choose a reason for hiding this comment

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

You can remove this as the typespec is checked in.

@mikeharder
Copy link
Member

Seems force merge doesn't fix the issue, maybe try to create a new branch from latest main and file another PR?

Yeah, there is still something strange about the history that's confusing git. First time I've ever seen this.

@Elina-L: If you don't mind creating a new PR, that would be easiest. Create a new branch from main, make only the changes you need in regular commits (no merges), and create a new PR to main.

If you want to keep this PR, you can do the same thing, but force-push to your existing branch, instead of pushing to a new branch and creating a new PR.

@Elina-L
Copy link
Member Author

Elina-L commented Jul 18, 2025

I've created a new PR here with all comments addressed aside from the following comment about removing code from the readme.md as there is Typespec: #35994 (comment)

PR link: #36039

@AzureRestAPISpecReview AzureRestAPISpecReview added the TypeSpec Authored with TypeSpec label Jul 21, 2025
@gary-x-li
Copy link
Contributor

@Elina-L This PR can be closed now, right?

@mentat9 mentat9 removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 5, 2025
@mentat9
Copy link
Member

mentat9 commented Aug 5, 2025

Removing WaitForARMFeedback to get this PR off the ARM reviewer's radar.

@microsoft-github-policy-service microsoft-github-policy-service bot added the no-recent-activity There has been no recent activity on this issue. label Aug 25, 2025
@github-actions
Copy link

github-actions bot commented Aug 25, 2025

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
    ❗❗❗ ARM review workflow label is missing! ❗❗❗TO UNBLOCK THIS PR, add /azp run comment to this PR to allow automation to determine where this PR is in the ARM review workflow.
    For details of the ARM review, see aka.ms/azsdk/pr-arm-review
  • ❌ The suppressions added to the AutoRest config files (README.mds) require review. Refer to step 1 in the PR workflow diagram, or to step 3, depending on the kind of suppression you did.

Important checks have failed. As of today they are not blocking this PR, but in near future they may.
Addressing the following failures is highly recommended:
  • ⚠️ The check named Swagger PrettierCheck has failed. 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


Comment generated by summarize-checks workflow run.

@microsoft-github-policy-service microsoft-github-policy-service bot removed the no-recent-activity There has been no recent activity on this issue. label Aug 25, 2025
@microsoft-github-policy-service microsoft-github-policy-service bot added no-recent-activity There has been no recent activity on this issue. and removed no-recent-activity There has been no recent activity on this issue. labels Sep 15, 2025
@microsoft-github-policy-service microsoft-github-policy-service bot added no-recent-activity There has been no recent activity on this issue. and removed no-recent-activity There has been no recent activity on this issue. labels Sep 29, 2025
@microsoft-github-policy-service microsoft-github-policy-service bot added no-recent-activity There has been no recent activity on this issue. and removed no-recent-activity There has been no recent activity on this issue. labels Oct 20, 2025
@microsoft-github-policy-service microsoft-github-policy-service bot added no-recent-activity There has been no recent activity on this issue. and removed no-recent-activity There has been no recent activity on this issue. labels Nov 3, 2025
@microsoft-github-policy-service
Copy link
Contributor

Hi, @@Elina-L. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

@microsoft-github-policy-service microsoft-github-policy-service bot added the no-recent-activity There has been no recent activity on this issue. label Nov 17, 2025
@microsoft-github-policy-service
Copy link
Contributor

Hi, @@Elina-L. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ARMReview Compute new-api-version no-recent-activity There has been no recent activity on this issue. PublishToCustomers Acknowledgement the changes will be published to Azure customers. resource-manager SuppressionReviewRequired TypeSpec Authored with TypeSpec

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants