[Hub Generated] Review request for Microsoft.Resources to add version stable/2022-12-01 #23292
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, @gauravkumar1491 Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
Object didn't pass validation for format uuid: 00000000-0000-0000-0000-00000000000000 Url: Microsoft.Resources/stable/2022-12-01/subscriptions.json#L630:32 ExampleUrl: stable/2022-12-01/examples/PostCheckZonePeers.json#L3:23 |
|
Object didn't pass validation for format uuid: 00000000-0000-0000-0000-00000000000000 Url: Microsoft.Resources/stable/2022-12-01/subscriptions.json#L630:32 ExampleUrl: stable/2022-12-01/examples/PostCheckZonePeers.json#L3:23 |
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⌛PoliCheck pending [Detail]
️🔄PrettierCheck inProgress [Detail]
️⌛SpellCheck pending [Detail]
️🔄Lint(RPaaS) inProgress [Detail]
️🔄CadlValidation inProgress [Detail]
️🔄TypeSpec Validation inProgress [Detail]
️⌛PR Summary pending [Detail]
Swagger Generation Artifacts
|
This was referenced Mar 25, 2023
This was referenced Mar 25, 2023
|
/azp run unifiedPipeline |
|
No pipelines are associated with this pull request. |
raych1
deleted the
gauravkumar1491-resources-Microsoft.Resources-2022-12-01
branch
This was referenced Apr 18, 2023
JoshLove-msft
pushed a commit
to JoshLove-msft/azure-rest-api-specs
that referenced
this pull request
Apr 25, 2023
… stable/2022-12-01 (Azure#23292) * Adds base for updating Microsoft.Resources from version stable/2021-01-01 to version 2022-12-01 * Updates readme * Updates API version in new specs and examples * Adding new version 2022-12-01 for Locations API * Correct version * removing resources.json from readme * Review comment * Validation error fixes * Model Validation Fix * Validation Error fix test * small fix * Missing files * Deleting files * Operations * Swagger ModelValidation fix * Operations api * removing previous commit * x-ms-example * missing curly * default response * Prettier errors fixed * Operation Schema * Breaking changes * Staging errror fix * Testing temp fix * common-types fix * staging lint diff warnings fixed * Testing v4 * v5 common types fix * Rollback * common-types fix * Removing redundant parameters * Model validation fix * GUID fix * uuid fix * ReadOnlyPropertChanged error fixed * uuid fix
| "description": "Gets details about a specified subscription.", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" |
There was a problem hiding this comment.
Would you let us know why previous local SubscriptionIdParameter with x-ms-parameter-location=method get replaced in 2022-12-01 by common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter?
The change from x-ms-parameter-location=method to x-ms-parameter-location=client breaks SDK and user.
Loop SDK owners @msyyc @qiliao123
There was a problem hiding this comment.
Also impact Go SDK. @gauravkumar1491 could you please confirm?
There was a problem hiding this comment.
@weidongxu-microsoft and @tadelesh The PR was flagged with Staging LintDiff errors where referencing the common types was required. These are common-types and should always be referenced instead of creating local parameters. Got approval in the Breaking Changes team meeting as well
There was a problem hiding this comment.
We can ignore LintDiff (I would be glad to, if this is the only error).
All your API is about subscriptions, hence it is actually not make sense to have "subscriptionId" in client parameter.
Before the change, user can call client.get(subscriptionId) to get information of any subscription they has interest on.
After the change, user can only call client.get() for the info of their subscription configured during client initialization.
If they want to check another subscription, they had to create another client first. (every single SDK owner, across language, feel this change is not valid)
SDK may not agree to release on this scenario, as the usability of SDK is greatly diminished.
There was a problem hiding this comment.
If you agree to revert back to prior SubscriptionIdParameter with x-ms-parameter-location=method, I can talk to Jeffrey and Mike on whether they can approve the revert PR (on breaking change), before you do the change.
There was a problem hiding this comment.
@weidongxu-microsoft I can add to x-ms-parameter-location=method to "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" and raise a new PR. Will that work?
There was a problem hiding this comment.
No, you cannot. It is a shared model under common-types. If you change it there, every other RP that uses it will get broken (and most RP does use a single subscriptionId).
There was a problem hiding this comment.
I've added a PR to revert #24088
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.