Purview Share Test Api Specification Update - Version 2023-05-30-preview #23993
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
kevinmichaelbowersox
requested review from
tg-msft
and removed request for
a team
|
Hi, @kevinmichaelbowersox 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 |
ghost
added
the
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| share.json | 2023-05-30-preview(5e26bc5) | 2023-02-15-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.2) | new version | base version |
|---|---|---|
| package-2023-05-30-preview | package-2023-05-30-preview(5e26bc5) | default(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| OperationId for put method should contain both 'Create' and 'Update' Location: Azure.Analytics.Purview.Share/preview/2023-05-30-preview/share.json#L66 |
|
| OperationId for put method should contain both 'Create' and 'Update' Location: Azure.Analytics.Purview.Share/preview/2023-05-30-preview/share.json#L412 |
|
| 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-05-30-preview/share.json#L2038 |
️️✔️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]
️️✔️TypeSpecAPIView 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.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
|
Care for this PR will be performed by @faisalaltell12 |
This was referenced May 15, 2023
mikekistler
approved these changes
May 15, 2023
| "properties": { | ||
| "nextLink": { | ||
| "description": "The Url of next result page.", | ||
| "type": "string" |
There was a problem hiding this comment.
The nextLink property should be format: url.
Suggested change
| "type": "string" | |
| "type": "string", | |
| "format": "url" |
| } | ||
| }, | ||
| "ShareResourceList": { | ||
| "description": "A page of Microsoft.Azure.Purview.Share.ApiService.V3.DataTransferObjects.ShareResource results.", |
There was a problem hiding this comment.
Suggested change
| "description": "A page of Microsoft.Azure.Purview.Share.ApiService.V3.DataTransferObjects.ShareResource results.", | |
| "description": "A page of ShareResource results.", |
| "type": "string" | ||
| }, | ||
| "value": { | ||
| "description": "Collection of items of type DataTransferObjects.", |
There was a problem hiding this comment.
Suggested change
| "description": "Collection of items of type DataTransferObjects.", | |
| "description": "Collection of items of type ShareResource.", |
Comment on lines
1768
to
1770
| "shareCounts": { | ||
| "$ref": "#/definitions/ShareCounts" | ||
| }, |
There was a problem hiding this comment.
Why nest these down inside a "ShareCounts" object? I think it will be better for users to simply put the two properties from "ShareCounts" here at the top level.
weidongxu-microsoft
approved these changes
May 16, 2023
...ation/purview/data-plane/Azure.Analytics.Purview.Share/preview/2023-05-30-preview/share.json
Outdated
Show resolved
Hide resolved
Thank you Mike, the tough part is getting the local build - swashbuckle process specifically - to automatically apply those changes. That way on future API versions we have less developer intervention (y) Got it all working finally! |
mikekistler
added
the
APIStewardshipBoard-SignedOff
|
@kevinmichaelbowersox (BTW, swashbuckle is not recommended...) |
|
Looks good! 👍 |
This was referenced May 23, 2023
6 tasks
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.
Data Plane API - Pull Request
Purview Share Test Api Specification Update - Version 2023-05-30-preview
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec 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 API Spec document (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