mgmt, resources subscriptions, revert SubscriptionIdParameter x-ms-parameter-location #24088
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, @weidongxu-microsoft 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. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| subscriptions.json | 2022-12-01(f0ff264) | 2022-12-01(main) |
| Rule | Message |
|---|---|
|
The new version has a different format than the previous one. New: Microsoft.Resources/stable/2022-12-01/subscriptions.json#L77:9 Old: Microsoft.Resources/stable/2022-12-01/subscriptions.json#L77:9 |
|
The new version has a different format than the previous one. New: Microsoft.Resources/stable/2022-12-01/subscriptions.json#L127:9 Old: Microsoft.Resources/stable/2022-12-01/subscriptions.json#L127:9 |
|
The new version has a different format than the previous one. New: Microsoft.Resources/stable/2022-12-01/subscriptions.json#L235:9 Old: Microsoft.Resources/stable/2022-12-01/subscriptions.json#L235:9 |
|
The new version has a different format than the previous one. New: Microsoft.Resources/stable/2022-12-01/subscriptions.json#L937:5 Old: common-types/resource-management/v5/types.json#L630:5 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 7 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.2) | new version | base version |
|---|---|---|
| package-subscriptions-2022-12 | package-subscriptions-2022-12(f0ff264) | package-subscriptions-2022-12(main) |
[must fix]The following errors/warnings are introduced by current PR:
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The path for the CURD methods do not contain a resource type. Location: Microsoft.Resources/stable/2022-12-01/subscriptions.json#L69 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Resources/stable/2022-12-01/subscriptions.json#L96 |
|
The path for the CURD methods do not contain a resource type. Location: Microsoft.Resources/stable/2022-12-01/subscriptions.json#L120 |
|
The path for the CURD methods do not contain a resource type. Location: Microsoft.Resources/stable/2022-12-01/subscriptions.json#L156 |
|
The path for the CURD methods do not contain a resource type. Location: Microsoft.Resources/stable/2022-12-01/subscriptions.json#L192 |
|
Path for 'post' method on a resource type MUST follow valid resource naming. Location: Microsoft.Resources/stable/2022-12-01/subscriptions.json#L228 |
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Resources/stable/2022-12-01/subscriptions.json#L84 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Resources/stable/2022-12-01/subscriptions.json#L772 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Resources/stable/2022-12-01/subscriptions.json#L777 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 0 Errors, 0 Warnings failed [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Comment on lines
+937
to
+944
| "SubscriptionIdParameter": { | ||
| "name": "subscriptionId", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The ID of the target subscription.", | ||
| "x-ms-parameter-location": "method" | ||
| }, |
There was a problem hiding this comment.
Revert it to be same as previous stable api-version 2021-01-01
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/resources/resource-manager/Microsoft.Resources/stable/2021-01-01/subscriptions.json#L821-L828
There was a problem hiding this comment.
@weidongxu-microsoft This looks good. Please go ahead if you can get approval from Mike on Breaking Changes
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @weidongxu-microsoft, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
This was referenced May 22, 2023
Merged
11 tasks
This was referenced May 22, 2023
mikekistler
added
the
Approved-BreakingChange
|
Approved breaking change for reason described in this comment. |
Wzb123456789
added
the
Approved-OkToMerge
This was referenced May 23, 2023
This was referenced May 23, 2023
weidongxu-microsoft
deleted the
mgmt_resources-subscriptions-revert-subscriptionId
branch
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.
ARM API Information (Control Plane)
Changelog
Add a changelog entry for this PR by answering the following questions:
Revert "x-ms-parameter-location" change (from "method" to "client") on subscriptions.json
https://github.com/Azure/azure-rest-api-specs/pull/23292/files#r1185657690
The "x-ms-parameter-location" change broke SDK and make it not usable.
The revert in PR does not affect REST API.
One minor effect would be that SubscriptionIdParameter in common-types has
format: uuid, while 2021-01-01 (and here) does not.I can add
format: uuidto local SubscriptionIdParameter, if all SDK is good with it (Java is fine as it always treat it as String, hence no change in SDK).No SDK ever released for api-version 2022-12-01
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. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
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.