[Management Plane][Azure Search] Introduce 2 new API versions for exposing shared private link management #10255
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
[Staging] Swagger Validation Report
Only 10 items are listed, please refer to log for more details.
❌ |
| Rule | Message |
|---|---|
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources' removed or restructured? Old: Microsoft.Search/preview/2019-10-01-preview/search.json#L1046:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}' removed or restructured? Old: Microsoft.Search/stable/2020-03-13/search.json#L888:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources' removed or restructured? Old: Microsoft.Search/stable/2020-03-13/search.json#L1052:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}' removed or restructured? Old: Microsoft.Search/preview/2019-10-01-preview/search.json#L882:5 |
|
The new version is missing a definition that was found in the old version. Was 'SharedPrivateLinkResourceProperties' removed or renamed? New: Microsoft.Search/preview/2019-10-01-preview/search.json#L980:3 Old: Microsoft.Search/preview/2019-10-01-preview/search.json#L1195:3 |
|
The new version is missing a definition that was found in the old version. Was 'SharedPrivateLinkResourceProperties' removed or renamed? New: Microsoft.Search/stable/2020-03-13/search.json#L986:3 Old: Microsoft.Search/stable/2020-03-13/search.json#L1201:3 |
|
The new version is missing a definition that was found in the old version. Was 'SharedPrivateLinkResource' removed or renamed? New: Microsoft.Search/stable/2020-03-13/search.json#L986:3 Old: Microsoft.Search/stable/2020-03-13/search.json#L1201:3 |
|
The new version is missing a definition that was found in the old version. Was 'SharedPrivateLinkResource' removed or renamed? New: Microsoft.Search/preview/2019-10-01-preview/search.json#L980:3 Old: Microsoft.Search/preview/2019-10-01-preview/search.json#L1195:3 |
|
The new version is missing a client parameter that was found in the old version. Was 'SharedPrivateLinkResourceNameParameter' removed or renamed? New: Microsoft.Search/stable/2020-03-13/search.json#L1603:3 Old: Microsoft.Search/stable/2020-03-13/search.json#L1947:3 |
|
The new version is missing a client parameter that was found in the old version. Was 'SharedPrivateLinkResourceNameParameter' removed or renamed? New: Microsoft.Search/preview/2019-10-01-preview/search.json#L1580:3 Old: Microsoft.Search/preview/2019-10-01-preview/search.json#L1912:3 |
️️✔️LintDiff [Detail]
️✔️Validation passes for LintDiff.
️️✔️Avocado [Detail]
️✔️Validation passes for Avocado.
️️✔️ModelValidation [Detail]
️✔️Validation passes for ModelValidation.
️️✔️SemanticValidation [Detail]
️✔️Validation passes for SemanticValidation.
openapi-assignment-bot
bot
added
the
WaitForARMFeedback
|
Azure Pipelines successfully started running 1 pipeline(s). |
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-python - Release
- Breaking Change detected in SDK
|
azure-sdk-for-java - Release
|
azure-sdk-for-go - Release
|
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-sdk-for-net - Release
|
|
2 diffs that should make things easier to review: Difference between 2020-03-13 and 2020-08-01 swagger specs (introduction of sharedPrivateLinkResources) Difference between the 2020-08-01 and 2020-08-01-Preview |
This was referenced Jul 25, 2020
|
Make sure you edit the file |
added 2 commits
July 24, 2020 17:10
|
Can one of the admins verify this patch? |
|
Azure Pipelines successfully started running 1 pipeline(s). |
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
|
* Changed stable 2020-08-01 * Changed preview 2020-08-01-preview * Changed PATCH for preview 2020-08-01-preview * Changed PATCH for stable 2020-08-01 Co-authored-by: Timothy Ta <timta@microsoft.com>
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Prior discussion about my changes, #10244 |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run public.rest-api-specs |
|
Azure Pipelines successfully started running 1 pipeline(s). |
markcowl
approved these changes
Aug 7, 2020
markcowl
added
the
Approved-BreakingChange
arv100kri
changed the title
|
NOTE: This is the .NET SDK PR that fixes the breaking change automation problem |
tjacobhi
approved these changes
Aug 26, 2020
timothyta12
approved these changes
Aug 26, 2020
arv100kri
changed the title
|
HI @arv100kri , can you fix linter and avocado validation failure? you should change Preview to preview in your version number to make consistent from others Microsoft.Search/preview/2020-08-01-preview/search.json#L6 |
|
Azure Pipelines successfully started running 1 pipeline(s). |
azure-resource-manager-schemas - Release
|
|
@ArcturusZhang GO SDK and @changlong-liu to take a look potential impact for breaking change as some of path removed in a stable version |
|
This will introduce breaking changes to go SDK - but I just checked in terraform, terraform is not using the paths that are removed in this PR, therefore these breaking changes do no impact to terraform |
|
Latest Python azure-mgmt-search is released with api-version '2015-08-19'. |
This was referenced Aug 27, 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.
In this PR, based on consultation from ARM API review board, Azure Search will be officially "removing"
sharedPrivateLinkResourcesfrom the existing API versions of2019-10-01-previewand2020-03-13. This is because we are introducing several improvements in those APIs, which necessitate breaking changes - and we currently gate those APIs and have 0 usage.In addition 2 new API versions are introduced, which will ship the
sharedPrivateLinkResourcesAPIs in the "desired" state.Also using the new API as an opportunity to utilize some of the common types instead of defining our own.
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.