Replace linkedWorkspaces with linkedService in 2020-09-01-preview #10545
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
️✔️ |
|
Azure Pipelines successfully started running 1 pipeline(s). |
azure-sdk-for-python - Release
- Breaking Change detected in SDK
|
azure-sdk-for-js - Release
|
azure-sdk-for-go - Release
|
azure-resource-manager-schemas - 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-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
|
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 CLI Extension Generation - Release
|
|
Can one of the admins verify this patch? |
|
Azure Pipelines successfully started running 1 pipeline(s). |
2 similar comments
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Azure Pipelines successfully started running 1 pipeline(s). |
ArcturusZhang
added
the
WaitForARMFeedback
RichardLi1437
force-pushed
the
newEndpointInNewVersion
branch
from
68d2712
to
bdcc3f9
Compare
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
LinkedService feature will be in private preview stage2 in middle Sept. We need to finalize this swagger file ASAP so that we can generate our SDKv2 based on this swagger, and make our SDK ready to use before mid Sept. Your timely review and approval is highly appreciated! |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
the first commit simply create copy 2020-05-01-preview to 2020-09-01-preview. Your can review the diff between latest commit and the 1st one to know what are changed. |
RichardLi1437
changed the title
pilor
suggested changes
Aug 24, 2020
| } | ||
| } | ||
| }, | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/linkedServices": { |
There was a problem hiding this comment.
linkedWorkspaces is changing name to linkedServices? This is a big breaking change for existing users, policy, templates, rbac, etc... why make this big of a change?
There was a problem hiding this comment.
We don't want to do the renaming either, but it is a business decision we have to follow. The good thing is that this feature is only in private preview stage with limited audience, so the impact to existing users is controllable.
We will add template support after this renaming.
We've updated the manifest to add new rbac in linkedAccessChecks.
What else do we need to take care of for the renaming?
There was a problem hiding this comment.
Deprecation process is called out here: https://armwiki.azurewebsites.net/api_contracts/APIDeprecationPolicy.html. If the existing API was a preview api-version then it is more flexible (as the doc calls out). Ensure you follow the steps of that process that apply to you (if preview then you get to choose based on what your customers expect from the API).
...er/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json
Show resolved
Hide resolved
pilor
added
ARMChangesRequested
|
Azure Pipelines successfully started running 1 pipeline(s). |
pilor
added
ARMSignedOff
pilor
approved these changes
Aug 25, 2020
ArcturusZhang
requested changes
Aug 26, 2020
| @@ -1233,18 +1233,18 @@ | |||
| } | |||
| } | |||
| }, | |||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/linkedWorkspaces": { | |||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/linkedServices": { | |||
| "get": { | |||
There was a problem hiding this comment.
Seems this API is designed to be paginated (inferred from the return type name PaginatedLinkedServiceList). If so, could we add a x-ms-pagable extension here?
There was a problem hiding this comment.
Also, if this is not pagable, could we change the type name to reduce confusion?
There was a problem hiding this comment.
@ArcturusZhang We don't support pagination yet, but I was told that if we don't support pagination in list API, some API checks will fail. Could you please confirm that? If that's not the case, we'd like to keep the previous simple array[] return type rather than a PaginatedList.
|
Azure Pipelines successfully started running 1 pipeline(s). |
Comment on lines
4060
to
4067
| "LinkedServiceList": { | ||
| "readOnly": true, | ||
| "type": "array", | ||
| "description": "An array of linked services", | ||
| "items": { | ||
| "$ref": "#/definitions/LinkedServiceResponse" | ||
| } | ||
| }, |
There was a problem hiding this comment.
This response should be wrapped in an object like this:
{
"value": [] // <- the array goes here
}
There was a problem hiding this comment.
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Azure Pipelines successfully started running 1 pipeline(s). |
ArcturusZhang
approved these changes
Aug 26, 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.
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.