Skip to content

Conversation

@audunn
Copy link
Member

@audunn audunn commented Oct 16, 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.

@github-actions
Copy link

github-actions bot commented Oct 16, 2025

Next Steps to Merge

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

Comment generated by summarize-checks workflow run.

@github-actions github-actions bot added the TypeSpec Authored with TypeSpec label Oct 16, 2025
@audunn
Copy link
Member Author

audunn commented Oct 16, 2025

This is for completness. We will not release SDKs for this version, since we have a new api-version 2025-09-01 being released very soon, service is being deployed, and will release SDKs based on that for this release cycle.

@github-actions
Copy link

github-actions bot commented Oct 16, 2025

API Change Check

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

Language API Review for Package
TypeSpec Microsoft.NetApp
Swagger Microsoft.NetApp
Go sdk/resourcemanager/netapp/armnetapp
JavaScript @azure/arm-netapp
Java com.azure.resourcemanager:azure-resourcemanager-netapp

@github-actions github-actions bot added ARMReview new-api-version resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required NotReadyForARMReview and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 16, 2025
@audunn audunn added the BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior label Oct 16, 2025
@github-actions github-actions bot added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed NotReadyForARMReview labels Oct 16, 2025
@audunn
Copy link
Member Author

audunn commented Oct 16, 2025

Braking change flag is for a change that was needed for bugfix where the spec was not mathcing the service behavior.
The response of the post operation getGroupIdListForLdapUser is returned by the service in the asycn-operation reponse. Clients like Azure CLI for example would not be able to deserialize the reponse for this reason.

Swagger avocado is for APIs that were deprecated long time ago. The tools does not seem to detect that. [MISSING_APIS_IN_DEFAULT_TAG] False positive on deprecated APIs

Can we set Approved-Avocado?

@github-actions github-actions bot added ARMAutoSignedOff ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required ARMAutoSignedOff ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review labels Oct 16, 2025
@audunn audunn added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Oct 16, 2025
…into release-Microsoft.NetApp-2025-08-01
/**
* Bucket resource
*/
@removed(Versions.v2025_08_01)
Copy link
Member

Choose a reason for hiding this comment

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

why is this being removed

Copy link
Member Author

Choose a reason for hiding this comment

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

This is staying in preview and not moving to stable in this version. We are newly converted over to TypeSpec and we are trying to modeal that behavior in TypeSpec for the first time.
If there is another better way to experss this in TypeSpec would love to see that.

Copy link
Contributor

Choose a reason for hiding this comment

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

Could you reach out TypeSpec Discussion | Azure SDK | Microsoft Teams channel for better guidance on this ?

Copy link
Member Author

@audunn audunn Oct 20, 2025

Choose a reason for hiding this comment

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

@ramoka178 Sure, asked this on the channel, The AI bot seems to agree with this approach.
Seems our mistake is not adding it again in the next preview, adding now.
example pattern

model FeatureX {
  @added(Versions.v1)
  @removed(Versions.v2)
  @added(Versions.v3Preview)
  previewProperty: string;
}

https://teams.microsoft.com/l/message/19:[email protected]/1760992024672?tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47&groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&parentMessageId=1760992016492&teamName=Azure%20SDK&channelName=TypeSpec%20Discussion&createdTime=1760992024672

Copy link
Member Author

Choose a reason for hiding this comment

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

@ramoka178 updated

@psah434 psah434 added ARMChangesRequested and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 17, 2025
@github-actions github-actions bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 17, 2025
@ramoka178 ramoka178 added ARMChangesRequested and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 20, 2025
@github-actions github-actions bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 20, 2025
@ramoka178 ramoka178 added Approved-Avocado ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 20, 2025
…into release-Microsoft.NetApp-2025-08-01
@audunn audunn merged commit 4b112dd into Azure:main Oct 21, 2025
38 of 41 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Approved-Avocado ARMAutoSignedOff ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required new-api-version PublishToCustomers Acknowledgement the changes will be published to Azure customers. resource-manager TypeSpec Authored with TypeSpec

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants