-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
[Datashare]Add sorting query parameters #10209
Conversation
[Staging] Swagger Validation Report
️✔️ |
Azure Pipelines successfully started running 1 pipeline(s). |
Azure CLI Extension Generation - Release
|
azure-sdk-for-go - Release
|
azure-sdk-for-net - Release
|
azure-sdk-for-java - 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-python - Release
- Breaking Change detected in SDK
|
azure-sdk-for-js - Release
|
azure-sdk-for-python-track2 - 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
|
Can one of the admins verify this patch? |
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
|
Hi @vnvaditya, can you give us change log for this PR? and help to adjust some order for operation to make diff tool more user friendly? it looks too many change in PR now |
Hello, here are the changes to the swagger that are included in this PR. 905c134ab079714cbbc85428fdf0c81339c53e6e 1227fe1fe951c6fbcb34522882cb8981e2733164 1f903fcda5995e61a3b7b2f62b5a19258aa29c4c ab26c7adf2cf678889772e233948ded338533ac3 39a0002fdf84927727f74b50c644a52c303cde9b (Just Sorting) |
Hi @vnvaditya, I mean the order of path/operation in swagger is different in new swagger. it caused me difficult to review which part is your really change. is this swagger generated automatically? |
@akning-ms - We are automatically generating the swagger and it was causing issues with reviews. So, we decided that we will order the operations and paths etc alphabetically for once. This will make reviews better going forward. |
I can create one PR with just the changes but will have to followup another PR for re-ordering. |
Azure Pipelines successfully started running 1 pipeline(s). |
@akning-ms - I reverted the ordering of the API's . Once this is approved and merged, I'll create another PR for re-ordering. |
Thanks @vnvaditya, LGTM for API perspecitve, but FYI, your PR changed breaking change for python sdk as show here: |
@akning-ms - The python failure was for my first iteration. After I reverted the API ordering, all 27 checks are passed and I think there are no breaking changes. |
Hi @vnvaditya , this change will bring breaking changes in Python SDK: #10209 (comment) . It's because new parameters are added. Please make sure they are expected. |
@changlong-liu - We just added query parameters for filtering and sorting. I'm not sure if this should be considered as breaking changes. The industry standard is we should be ok with query parameters. Also, Java, .net and other sdk's seems fine. If Python restricts us by doing so, we are fine with this breaking change. We don't have any Python SDK customers based on the traffic and communicate if we have any. Please sign off. Thanks, |
Hi @vnvaditya , adding query parameters is a breaking change in current Python SDK. You may refer to here to understand why it is breaking: AzureSDKAutomation/azure-sdk-for-python@50af844#diff-6602c76927522f9562221eff283c90ceR250 For other languages: if they don't have tail parameters like custom_headers and raw, then it's not a breaking change. |
…into fix_kv_python_readme * 'master' of https://github.com/Azure/azure-rest-api-specs: (154 commits) Key Vault 7.1-preview to stable (GA) (Azure#10239) Fix data plane cosmosdb (Azure#10277) Fix example request for expanding policyEvaluationDetails (Azure#10203) Databricks Swagger Changes for Double Encryption (Azure#9941) add column delimiter for SAP Table/open hub (Azure#10269) add doc for typescript md (Azure#10187) Fix sfrp 2020-01-01-preview (Azure#10268) [Datafactory]Add cloudType and snapshot to ADF public swagger (Azure#10235) Migrate TaskRun to ProxyResource. (Azure#9953) [Datashare]Add sorting query parameters (Azure#10209) [Hub Generated] Review request for Microsoft.Insights to add version preview/2018-06-17-preview (Azure#10173) Update dataController onPremise property (Azure#10263) Changed the Client description to include Gen2 (Azure#10178) Managed Clusters Generate SDK (Azure#10247) Dev monitor microsoft.insights 2020 05 01 preview (Azure#10101) Add Location property to ExportPipeline and ImportPipeline (Azure#10177) Add enableAutomaticUpgrade property to VMExtensions for VMs and VMSS (Azure#10134) Add a new api and add 2020-02-02-preview versions (Azure#9710) Adding AML Workspace ID Property (Azure#10073) Add missing nullable attributes (Azure#10245) ...
* unhidden status * add typescript to sdk automation * add pagination query parameters * re-vert re-ordering of the API's Co-authored-by: Crystal YU <chunyu@microsoft.com> Co-authored-by: Aditya Vutukuri <advutuku@microsoft.com>
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.
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.