Move subscriptionId to global#2670
Conversation
Automation for azure-sdk-for-nodeNothing to generate for azure-sdk-for-node |
Automation for azure-libraries-for-javaA PR has been created for you based on this PR content. Once this PR will be merged, content will be added to your service PR: |
Automation for azure-sdk-for-pythonA PR has been created for you based on this PR content. Once this PR will be merged, content will be added to your service PR: |
Automation for azure-sdk-for-goA PR has been created for you: |
|
@vivsriaus is there a good reason to introduce SDK breaking changes in the old stable API version? |
| "type": "string", | ||
| "description": "The ID of the target subscription." | ||
| "$ref": "#/parameters/ApiVersionParameter" | ||
| }, |
There was a problem hiding this comment.
@vivsriaus the order of parameters does matter for some SDKs. Please, revert back to
- the subscription is should be the first parameter,
- the api version should be the second parameter.
You may change the order in the next api version.
|
@sergey-shandar With regards to your comment about introducing breaking changes, we're doing this because our file was flagged as non compliant per Mohammed Zehgir. (non compliant because we were not using subId as a global parameter). Also, can you explain how this is considered a breaking change? The subscriptionId parameter is still required in the modified operations, right? |
|
@vivsriaus it's breaking changes for SDKs because the parameters and their order are changed. We generate Azure SDK using the swagger files. So imagine Azure SDK C# DLL, one version of this DLL has a function with one parameter type and the new version of this DLL has a function with different parameter types and order of the parameters is changed. |
|
@vivsriaus thanks for changing the order back. It's not an SDK breaking change anymore. |
| "required": true, | ||
| "type": "string", | ||
| "description": "The ID of the target subscription." | ||
| }, |
There was a problem hiding this comment.
please, add "x-ms-parameter-location": "client"
There was a problem hiding this comment.
What does this give us?
There was a problem hiding this comment.
Never mind, I get it now
| }, | ||
| "ApiVersionParameter": { | ||
| "name": "api-version", | ||
| "in": "query", |
There was a problem hiding this comment.
please, add "x-ms-parameter-location": "client" to the ApiVersionParameter as well.
|
@vivsriaus @sergey-shandar This is a massive breaking change :(. This is moving from a local parameter to a client parameter :( |
|
But yeah, it's written |
|
@AutorestCI regenerate azure-sdk-for-python |
|
Ok, this is definitely a massive breaking change.... |
4 participants
This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.
PR information
api-versionin the path should match theapi-versionin the spec).Quality of Swagger