[Purview - API Scanning] API Review 2022-07-01-preview #19797
Merged
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
|
Hi, @pvadali-az 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.9.7)] | new version | base version |
|---|---|---|
| scanningService.json | 2022-07-01-preview(c3e868b) | 2022-02-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.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 213 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-07-01-preview | package-2022-07-01-preview(c3e868b) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 30 items are listed, please refer to log for more details.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
Validation passes for ServiceAPIReadinessTest.
️️✔️~[Staging] TrafficValidation 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.
️⚠️SDK Track2 Validation: 78 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/c3e868b344281dc855c6a2c8352315c5f17f49c7/specification/purview/data-plane/readme.md#tag-package-2022-07-01-preview">purview/data-plane/readme.md#package-2022-07-01-preview
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'AzureKeyVaultProperties' -> 'AzureKeyVaultPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'FilterProperties' -> 'FilterPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'ManagedVirtualNetworkProperties' -> 'ManagedVirtualNetworkPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'ManagedPrivateEndpointProperties' -> 'ManagedPrivateEndpointPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'TriggerProperties' -> 'TriggerPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'SystemClassificationRuleProperties' -> 'SystemClassificationRulePropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'CustomClassificationRuleProperties' -> 'CustomClassificationRulePropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'RoleARNCredentialProperties' -> 'RoleARNCredentialPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'ServicePrincipalAzureKeyVaultCredentialProperties' -> 'ServicePrincipalAzureKeyVaultCredentialPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'ManagedIdentityAzureKeyVaultCredentialProperties' -> 'ManagedIdentityAzureKeyVaultCredentialPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'ManagedIntegrationRuntimeProperties' -> 'ManagedIntegrationRuntimePropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'SelfHostedIntegrationRuntimeProperties' -> 'SelfHostedIntegrationRuntimePropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'SelfHostedIntegrationRuntimeStatusProperties' -> 'SelfHostedIntegrationRuntimeStatusPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'ManagedIntegrationRuntimeStatusProperties' -> 'ManagedIntegrationRuntimeStatusPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'AzureSubscriptionScanRulesetProperties' -> 'AzureSubscriptionScanRulesetPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'AzureResourceGroupScanRulesetProperties' -> 'AzureResourceGroupScanRulesetPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'AzureSynapseWorkspaceScanRulesetProperties' -> 'AzureSynapseWorkspaceScanRulesetPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'AzureSynapseScanRulesetProperties' -> 'AzureSynapseScanRulesetPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'AdlsGen1ScanRulesetProperties' -> 'AdlsGen1ScanRulesetPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'AdlsGen2ScanRulesetProperties' -> 'AdlsGen2ScanRulesetPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'AmazonAccountScanRulesetProperties' -> 'AmazonAccountScanRulesetPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'AmazonS3ScanRulesetProperties' -> 'AmazonS3ScanRulesetPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'AmazonSqlScanRulesetProperties' -> 'AmazonSqlScanRulesetPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'AzureCosmosDbScanRulesetProperties' -> 'AzureCosmosDbScanRulesetPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'AzureDataExplorerScanRulesetProperties' -> 'AzureDataExplorerScanRulesetPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'AzureFileServiceScanRulesetProperties' -> 'AzureFileServiceScanRulesetPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'AzureSqlDatabaseScanRulesetProperties' -> 'AzureSqlDatabaseScanRulesetPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'AmazonPostgreSqlScanRulesetProperties' -> 'AmazonPostgreSqlScanRulesetPropertiesAutoGenerated'" |
|
| "readme":"purview/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Deduplicating schema name: 'AzurePostgreSqlScanRulesetProperties' -> 'AzurePostgreSqlScanRulesetPropertiesAutoGenerated'" |
️️✔️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
|
pvadali-az
changed the title
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @pvadali-az your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
pvadali-az
requested review from
tg-msft and
johanste
and removed request for
a team
pvadali-az
changed the title
markweitzel
changed the title
2 tasks
rkmanda
removed
WaitForARMFeedback
2 tasks
pvadali-az
changed the title
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Hi @pvadali-az, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
.../data-plane/Azure.Analytics.Purview.Scanning/preview/2022-07-01-preview/scanningService.json
Show resolved
Hide resolved
.../data-plane/Azure.Analytics.Purview.Scanning/preview/2022-07-01-preview/scanningService.json
Show resolved
Hide resolved
.../data-plane/Azure.Analytics.Purview.Scanning/preview/2022-07-01-preview/scanningService.json
Outdated
Show resolved
Hide resolved
| } | ||
| } | ||
| }, | ||
| "/integrationruntimes/{integrationRuntimeName}/disableInteractiveQuery": { |
There was a problem hiding this comment.
Endpoint seems not consistent. Should it be ":disableInteractiveQuery" as an action?
There was a problem hiding this comment.
This was an oversight by me since we did not discuss about this endpoint in specific. Since this needs a service change and Scannning is going switch over to manual generation of swagger, they will address this there. If this is a hard requirement for this PR, I can accommodate that service change (mentioned about this in the email)
There was a problem hiding this comment.
changed to /integrationruntimes/{integrationRuntimeName}:disableInteractiveQuery
| "200": { | ||
| "description": "Success", | ||
| "schema": { | ||
| "$ref": "#/definitions/IActionResult" |
There was a problem hiding this comment.
I think it is an object without any properties? That is meaningless to user.
There was a problem hiding this comment.
Explained in the email. This and http 204 have same underlying problem.
There was a problem hiding this comment.
It is used in 200.
So it is intended to be 200 but still with response body as "{}"?
.../data-plane/Azure.Analytics.Purview.Scanning/preview/2022-07-01-preview/scanningService.json
Show resolved
Hide resolved
.../data-plane/Azure.Analytics.Purview.Scanning/preview/2022-07-01-preview/scanningService.json
Show resolved
Hide resolved
.../data-plane/Azure.Analytics.Purview.Scanning/preview/2022-07-01-preview/scanningService.json
Show resolved
Hide resolved
.../data-plane/Azure.Analytics.Purview.Scanning/preview/2022-07-01-preview/scanningService.json
Show resolved
Hide resolved
Comment on lines
+3701
to
+3704
| "status": { | ||
| "type": "string", | ||
| "readOnly": true | ||
| } |
There was a problem hiding this comment.
Yes, but there is no clarity on what the expected values are even within my change. Several properties could be enums, but DataFactory's swagger did not mark them as enums and hence swashbuckle did not generate enums from Datafactory provided models. This will be a bigger change and I felt it is a bit out of scope for this PR. Let me know. (also explained in the email)
mikekistler
requested changes
Sep 18, 2022
There was a problem hiding this comment.
@weidongxu-microsoft has pointed out a number of issues and I have added a few more.
Please address these and then flag us to re-review.
.../data-plane/Azure.Analytics.Purview.Scanning/preview/2022-07-01-preview/scanningService.json
Outdated
Show resolved
Hide resolved
.../data-plane/Azure.Analytics.Purview.Scanning/preview/2022-07-01-preview/scanningService.json
Outdated
Show resolved
Hide resolved
.../data-plane/Azure.Analytics.Purview.Scanning/preview/2022-07-01-preview/scanningService.json
Outdated
Show resolved
Hide resolved
.../data-plane/Azure.Analytics.Purview.Scanning/preview/2022-07-01-preview/scanningService.json
Outdated
Show resolved
Hide resolved
.../data-plane/Azure.Analytics.Purview.Scanning/preview/2022-07-01-preview/scanningService.json
Outdated
Show resolved
Hide resolved
.../data-plane/Azure.Analytics.Purview.Scanning/preview/2022-07-01-preview/scanningService.json
Outdated
Show resolved
Hide resolved
.../data-plane/Azure.Analytics.Purview.Scanning/preview/2022-07-01-preview/scanningService.json
Outdated
Show resolved
Hide resolved
.../data-plane/Azure.Analytics.Purview.Scanning/preview/2022-07-01-preview/scanningService.json
Outdated
Show resolved
Hide resolved
AzureRestAPISpecReview
added
ARMReview
WaitForARMFeedback
mikekistler
approved these changes
Sep 22, 2022
weidongxu-microsoft
approved these changes
Sep 22, 2022
weidongxu-microsoft
removed
the
WaitForARMFeedback
tjprescott
approved these changes
Sep 30, 2022
|
@pvadali-az you will need to address the failing Avocado checks to merge this. |
weidongxu-microsoft
added
the
APIStewardshipBoard-SignedOff
@tjprescott I fixed avocado errors just now. I will have to wait until next to merge this since service change hasn't rolled out to all regions. |
This was referenced Oct 12, 2022
anandanthony
pushed a commit
to anandMicro/azure-rest-api-specs
that referenced
this pull request
Dec 16, 2022
* Adding a new dataplane api scanning version * fixing example validation * adds new scanning version details to ReadMe * fixing validation errors * marks value as requried field for paginated results * pr feedback * fixing examples * fixing examples * fixing examples * fixing examples * setting managedVNetName to default * setting managedVNetName to default * pr feedback, initial commit * fixes validation errors * fixes model-validation errors * pr feedback * pr feedback * remove error code header * changing path pattern for interactiveQuery APIs * fixes avocado
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
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