Skip to content

SRP Jan25 [2025-01-01] API Version Swagger Changes #33529

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 23 commits into
base: main
Choose a base branch
from

Conversation

ajashant-msft
Copy link
Member

Choose a PR Template

Switch to "Preview" on this description then select one of the choices below.

Click here to open a PR for a Data Plane API.

Click here to open a PR for a Control Plane (ARM) API.

Click here to open a PR for only SDK configuration.

@github-actions github-actions bot added the brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. label Mar 27, 2025
@microsoft-github-policy-service microsoft-github-policy-service bot added the Storage Storage Service (Queues, Blobs, Files) label Mar 27, 2025
@azure-sdk
Copy link
Collaborator

azure-sdk commented Mar 27, 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.Storage
Java com.azure.resourcemanager:azure-resourcemanager-storage-generated
JavaScript @azure/arm-storage
Go sdk/resourcemanager/storage/armstorage

Copy link
Member

@blueww blueww left a comment

Choose a reason for hiding this comment

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

Besides my other comments, please don't merge the PR before this API version is really available in all regions (include mooncake, usgov, ....)

Copy link

openapi-pipeline-app bot commented Mar 27, 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 Swagger LintDiff 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

Copy link

openapi-pipeline-app bot commented Mar 27, 2025

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

@blueww
Copy link
Member

blueww commented Apr 1, 2025

A SRP swagger PR is merged with 2024-01-01 API change.
Please rebase this PR with that change.

#33569

@microsoft-github-policy-service microsoft-github-policy-service bot added the no-recent-activity There has been no recent activity on this issue. label Apr 21, 2025
@ajashant-msft
Copy link
Member Author

Hi, @@ajashant-msft. 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 removed the no-recent-activity There has been no recent activity on this issue. label Apr 21, 2025
@ajashant-msft ajashant-msft reopened this Apr 21, 2025
Copy link

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels May 17, 2025
@AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required NotReadyForARMReview and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels May 21, 2025
@openapi-pipeline-app openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 21, 2025
@AzureRestAPISpecReview AzureRestAPISpecReview removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 21, 2025
@ajashant-msft
Copy link
Member Author

    "isSmbOAuthEnabled": {

Replace boolean/switch properties with a more meaningful enum whenever possible. Enums are always a more flexible and future proof option because they allow additional values to be added in the future in a non-breaking way, e.g. [Enabled, Disabled, Suspended, Deallocated].

In this case ou could have for example a enabledAuthType with values like [None, SMB]

Refers to: specification/storage/resource-manager/Microsoft.Storage/stable/2025-01-01/storage.json:3107 in 34ef94b. [](commit_id = 34ef94b, deletion_comment = False)

thank you for your comment. we don't have any plans of adding more options. this is a simple true/false property similar to isSftpEnabled and others.

golddove and others added 2 commits May 23, 2025 06:38
@AzureRestAPISpecReview AzureRestAPISpecReview added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed NotReadyForARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels May 23, 2025
…tiveDirectoryProperties swagger, improve descriptions"

This reverts commit 0d20628.
@MaximeKjaer MaximeKjaer added the BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior label May 23, 2025
],
"description": "Setting property for Managed Identity access over SMB using OAuth"
},
"ActiveDirectoryProperties": {
Copy link
Member

Choose a reason for hiding this comment

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

Clarifying the BreakingChange-Approved-BugFix label: the "breaking" change is the removal of required in this section. The REST API does not consider these properties required, so we're aligning the swagger to match. In other words, this is a swagger bug fix, not an actual change in REST API behavior.

@AzureRestAPISpecReview AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label May 23, 2025
@gary-x-li
Copy link
Contributor

Please respond to this comment.

@gary-x-li gary-x-li added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 27, 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 May 27, 2025
@ajashant-msft
Copy link
Member Author

Besides my other comments, please don't merge the PR before this API version is really available in all regions (include mooncake, usgov, ....)

Wei-Wei -- does all regions include air-gapped?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior BreakingChange-Go-Sdk BreakingChange-JavaScript-Sdk BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. new-api-version resource-manager RPaaS Storage Storage Service (Queues, Blobs, Files)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants