Skip to content
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

Move subscriptionId to global #2670

Merged
merged 3 commits into from
Mar 19, 2018
Merged

Conversation

vivsriaus
Copy link
Contributor

@vivsriaus vivsriaus commented Mar 15, 2018

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

  • The title of the PR is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For information on cleaning up the commits in your pull request, see this page.
  • Except for special cases involving multiple contributors, the PR is started from a fork of the main repository, not a branch.
  • If applicable, the PR references the bug/issue that it fixes.
  • Swagger files are correctly named (e.g. the api-version in the path should match the api-version in the spec).

Quality of Swagger

@AutorestCI
Copy link

AutorestCI commented Mar 15, 2018

Automation for azure-sdk-for-node

Nothing to generate for azure-sdk-for-node

@AutorestCI
Copy link

AutorestCI commented Mar 15, 2018

Automation for azure-libraries-for-java

A 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:
Azure/azure-libraries-for-java#293

@AutorestCI
Copy link

AutorestCI commented Mar 15, 2018

Automation for azure-sdk-for-python

A 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:
Azure/azure-sdk-for-python#2029

@AutorestCI
Copy link

AutorestCI commented Mar 15, 2018

Automation for azure-sdk-for-go

A PR has been created for you:
Azure/azure-sdk-for-go#1334

@sergey-shandar
Copy link
Contributor

@vivsriaus is there a good reason to introduce SDK breaking changes in the old stable API version?

"required": true,
"type": "string",
"description": "The ID of the target subscription."
"$ref": "#/parameters/ApiVersionParameter"
},
Copy link
Contributor

@sergey-shandar sergey-shandar Mar 16, 2018

Choose a reason for hiding this comment

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

@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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@vivsriaus vivsriaus requested a review from a user March 16, 2018 19:02
@vivsriaus
Copy link
Contributor Author

@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?

@sergey-shandar
Copy link
Contributor

sergey-shandar commented Mar 16, 2018

@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.

@sergey-shandar
Copy link
Contributor

sergey-shandar commented Mar 16, 2018

@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."
},
Copy link
Contributor

Choose a reason for hiding this comment

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

please, add "x-ms-parameter-location": "client"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What does this give us?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Never mind, I get it now

"required": true,
"type": "string",
"description": "The ID of the target subscription."
},
"ApiVersionParameter": {
"name": "api-version",
"in": "query",
Copy link
Contributor

Choose a reason for hiding this comment

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

please, add "x-ms-parameter-location": "client" to the ApiVersionParameter as well.

@lmazuel
Copy link
Member

lmazuel commented Mar 20, 2018

@vivsriaus @sergey-shandar This is a massive breaking change :(. This is moving from a local parameter to a client parameter :(

@lmazuel
Copy link
Member

lmazuel commented Mar 20, 2018

But yeah, it's written client, so what the hell Python is generating out of this :(
............

@lmazuel
Copy link
Member

lmazuel commented Mar 20, 2018

@AutorestCI regenerate azure-sdk-for-python

@lmazuel
Copy link
Member

lmazuel commented Mar 20, 2018

Ok, this is definitely a massive breaking change....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants