-
Notifications
You must be signed in to change notification settings - Fork 5k
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
Purview Share V2 Specs - Data plane #22316
Conversation
All changes missing Kevin's sink changes
This commit makes the following updates to the specifications: - Removes /v2 from routes in the api specification. - Removes sink property from detached received share examples.
…-detached-received-share-update Purview Share Specification Adjustments for Resources and Routes
Hi, @faisalaltell Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
share.json | 2023-02-15-preview(5193c61) | 2021-09-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/sentShares/{sentShareName}/assets' removed or restructured? Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L9:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/sentShares/{sentShareName}/assets/{assetName}' removed or restructured? Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L61:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/receivedShares/{receivedShareName}/assetMappings' removed or restructured? Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L203:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/receivedShares/{receivedShareName}/assetMappings/{assetMappingName}' removed or restructured? Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L255:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/receivedInvitations' removed or restructured? Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L403:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/receivedInvitations/{receivedInvitationName}' removed or restructured? Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L452:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/receivedInvitations/{receivedInvitationName}:reject' removed or restructured? Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L492:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/receivedShares' removed or restructured? Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L556:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/receivedShares/{receivedShareName}/receivedAssets' removed or restructured? Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L731:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/sentShares/{sentShareName}/acceptedSentShares' removed or restructured? Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L958:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/sentShares/{sentShareName}/acceptedSentShares/{acceptedSentShareName}' removed or restructured? Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1004:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/sentShares/{sentShareName}/acceptedSentShares/{acceptedSentShareName}:reinstate' removed or restructured? Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1047:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/sentShares/{sentShareName}/acceptedSentShares/{acceptedSentShareName}:revoke' removed or restructured? Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1109:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/sentShares/{sentShareName}/acceptedSentShares/{acceptedSentShareName}:update-expiration' removed or restructured? Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1159:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/activateEmail' removed or restructured? Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1419:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/registerEmail' removed or restructured? Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1474:5 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'AcceptedSentShare' removed or renamed? New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3 Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'AdlsGen2AccountAsset' removed or renamed? New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3 Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'AdlsGen2AccountAssetMapping' removed or renamed? New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3 Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'AdlsGen2AccountAssetMappingProperties' removed or renamed? New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3 Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'AdlsGen2AccountAssetProperties' removed or renamed? New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3 Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'AdlsGen2AccountReceivedAsset' removed or renamed? New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3 Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'AdlsGen2AccountReceivedAssetProperties' removed or renamed? New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3 Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'ApplicationInvitation' removed or renamed? New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3 Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'ApplicationInvitationProperties' removed or renamed? New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3 Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'ApplicationReceivedInvitation' removed or renamed? New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3 Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'ApplicationReceivedInvitationProperties' removed or renamed? New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3 Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'Asset' removed or renamed? New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3 Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'AssetMapping' removed or renamed? New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3 Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'AssetMappingStatus' removed or renamed? New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3 Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3 |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 12 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-2023-02-15-preview | package-2023-02-15-preview(5193c61) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
OperationId for put method should contain both 'Create' and 'Update' Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L66 |
||
OperationId for put method should contain both 'Create' and 'Update' Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L421 |
||
Consider using x-ms-client-flatten to provide a better end user experience Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L961 |
||
Consider using x-ms-client-flatten to provide a better end user experience Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L1008 |
||
Consider using x-ms-client-flatten to provide a better end user experience Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L1066 |
||
Consider using x-ms-client-flatten to provide a better end user experience Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L1113 |
||
Consider using x-ms-client-flatten to provide a better end user experience Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L1153 |
||
Consider using x-ms-client-flatten to provide a better end user experience Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L1253 |
||
Consider using x-ms-client-flatten to provide a better end user experience Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L1611 |
||
Consider using x-ms-client-flatten to provide a better end user experience Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L1844 |
||
Consider using x-ms-client-flatten to provide a better end user experience Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L1929 |
||
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L1947 |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
HostParametersValidation |
The host parameter must be typed 'type 'string', format 'url''. Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L2096 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️
~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi @faisalaltell, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi @faisalaltell, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I made a quick pass and found some minor issues -- hopefully all easy fixes.
...ation/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json
Show resolved
Hide resolved
"Azure-AsyncOperation": { | ||
"description": "The URL to track the status of the long running operation.", | ||
"type": "string" | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Data-plane services should not return the "Azure-AsyncOperation" header.
"summary": "Create or replace a sent share.", | ||
"description": "Create a sent share", | ||
"operationId": "SentShares_Create", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is confusing. Does this operation only create or can it also replace? Please make the summary, description, and operationId consistent. And if replace is supported, add a 200 response.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mikekistler In case of a replace, it might be long running as well. Is it ok to return a 200 with a long running operation header?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes.
...ation/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json
Show resolved
Hide resolved
"Azure-AsyncOperation": { | ||
"description": "The URL to track the status of the long running operation.", | ||
"type": "string" | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No "Azure-AsyncOperation" header in data-plane.
"Azure-AsyncOperation": { | |
"description": "The URL to track the status of the long running operation.", | |
"type": "string" | |
} |
...ation/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json
Show resolved
Hide resolved
"Azure-AsyncOperation": { | ||
"description": "The URL to track the status of the long running operation.", | ||
"type": "string" | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No "Azure-AsyncOperation" header in data-plane.
"properties": { | ||
"properties": { | ||
"$ref": "#/definitions/AdlsGen2AccountSinkProperties", | ||
"x-ms-client-flatten": true |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please remove all instances of "x-ms-client-flatten". This extension is deprecated and no longer supported by our client generators.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple more small issues.
], | ||
"summary": "Create or replace a received share.", | ||
"description": "Update changes to a received share", | ||
"operationId": "ReceivedShares_CreateOrUpdate", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"operationId": "ReceivedShares_CreateOrUpdate", | |
"operationId": "ReceivedShares_CreateOrReplace", |
], | ||
"summary": "Create or replace a sent share.", | ||
"description": "Create or replace a sent share", | ||
"operationId": "SentShares_CreateOrUpdate", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"operationId": "SentShares_CreateOrUpdate", | |
"operationId": "SentShares_CreateOrReplace", |
add 202 to deletes
datetime rfc, state, route changes
CreateOrReplace rename, description enum rename
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. 👍
@Azure/api-stewardship-board Could we get one more review/approve on this API? |
@anuchandy I think this PR is ready to merge. Would you please do the honors. |
* add changes * clean up * clean up * Purview Share Specification Adjustments for Resources and Routes This commit makes the following updates to the specifications: - Removes /v2 from routes in the api specification. - Removes sink property from detached received share examples. * pipeline failures * Remove comma that is not needed * adjust incorrect spelling of word * commit changes * test fix * fixes * remove unneccessary files * lro headers fix * error fix * changes * changes * readme.md * changes * add security * Filter and security * push changes * changes * changes * changes * changes * Update examples * change * changes * add 202 to deletes * datetime rfc, state, route changes * CreateOrReplace rename, description enum rename --------- Co-authored-by: faisalaltell12 <faisalaltell@gmail.com> Co-authored-by: kbowersox <kbowersox@microsoft.com> Co-authored-by: kevinmichaelbowersox <99699543+kevinmichaelbowersox@users.noreply.github.com>
Data Plane API - Pull Request
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous Open API document (swagger) if applicable, and the root paths that have been updated.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links