set x-ms-client-name #11190
Merged
set x-ms-client-name #11190
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
changlong-liu
requested review from
dkulkarni-ms,
grizzlytheodore,
haagha,
hyonholee,
madewithsmiles,
MS-syh2qs and
Sandido
as code owners
[Staging] Swagger Validation Report
️✔️ |
|
Azure Pipelines successfully started running 1 pipeline(s). |
azure-sdk-for-java - Release
|
azure-sdk-for-net - Release
|
Trenton Generation - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
azure-sdk-for-go - Release
|
azure-sdk-for-python - Release
|
azure-sdk-for-python-track2 - Release
- Breaking Change detected in SDK
|
azure-sdk-for-js - Release
|
Azure CLI Extension Generation - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
azure-resource-manager-schemas - Release
|
This was referenced Oct 14, 2020
This was referenced Oct 14, 2020
|
for fix issue: Azure/azure-sdk-for-python#14150 |
|
Hi @hyonholee @grizzlytheodore would you help to review this PR? The reported Python SDK breaking change comes from previous PRs, don't for this PR. |
yungezz
reviewed
Oct 19, 2020
| @@ -6230,6 +6230,7 @@ | |||
| "type": "object", | |||
| "additionalProperties": { | |||
| "type": "object", | |||
| "x-ms-client-name": "userAssignedIdentitiesValue", | |||
There was a problem hiding this comment.
this is on old version, has this API version been releaesd in SDK already? If yes, specifying new client name will cause SDK breaking change right?
There was a problem hiding this comment.
Hi @yungezz , yes, the API version has been released.
The effect for this setting:
- Will cause NO breaking-change for Track1 SDK. (since this set the same client-name as what the modeler1 can guess)
- Will cause breaking change for Track2 SDK. (for fix issue found in azure-mgmt-compute: VirtualMachineIdentityUserAssignedIdentitiesValue became mangled somewhere between 13.0.0 and 17.0.0 azure-sdk-for-python#14150)
The root cause I submit this PR is the modeler4 guess different name with modeler1, which will cause the above issue in Track2.
CC to @jsntcy
There was a problem hiding this comment.
thanks @changlong-liu . For Track1, this set the same client-name as what the modeler1 can guess this is true for other language SDKs also right, since all SDKs based on modeler1? For Track2, only Python SDK consuming x-ms-client-name? If both yes, I'll approve and merge the PR.
There was a problem hiding this comment.
Hi @yungezz , yes, This will make no change in any language SDK in Track1
There was a problem hiding this comment.
@changlong-liu how about Track2?
There was a problem hiding this comment.
Hi @yungezz, the x-ms-client-name is used by modeler4, so all language Track2 SDK will respect this setting.
I guess all released Track2 SDKs will have problem similar to Azure/azure-sdk-for-python#14150. So this is a breaking-change/bug-fix for all released track2 SDK.
yungezz
approved these changes
Oct 19, 2020
|
hi @dingmeng-xue will Powershell generator read |
Yes. |
giromm2ms
pushed a commit
to giromm2ms/azure-rest-api-specs
that referenced
this pull request
Dec 20, 2020
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.
Please follow the link to find more details on PR review process.