Dkatyal/test read me #24643
Draft
Dkatyal/test read me #24643
Conversation
This file contains hidden or 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
…01 to version 2023-05-01
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| types.json | 4.0(6185f6e) | 4.0(main) |
️⚠️Breaking Change(Cross-Version): 50 Warnings warning [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| azureADOnlyAuthentication.json | 2023-05-01(6185f6e) | 2021-06-01(main) |
| azureADOnlyAuthentication.json | 2023-05-01(6185f6e) | 2021-06-01-preview(main) |
| bigDataPool.json | 2023-05-01(6185f6e) | 2021-06-01(main) |
| bigDataPool.json | 2023-05-01(6185f6e) | 2021-06-01-preview(main) |
| checkNameAvailability.json | 2023-05-01(6185f6e) | 2021-06-01(main) |
| checkNameAvailability.json | 2023-05-01(6185f6e) | 2021-06-01-preview(main) |
| firewallRule.json | 2023-05-01(6185f6e) | 2021-06-01(main) |
| firewallRule.json | 2023-05-01(6185f6e) | 2021-06-01-preview(main) |
| integrationRuntime.json | 2023-05-01(6185f6e) | 2021-06-01(main) |
| integrationRuntime.json | 2023-05-01(6185f6e) | 2021-06-01-preview(main) |
| keys.json | 2023-05-01(6185f6e) | 2021-06-01(main) |
| keys.json | 2023-05-01(6185f6e) | 2021-06-01-preview(main) |
| library.json | 2023-05-01(6185f6e) | 2021-06-01(main) |
| library.json | 2023-05-01(6185f6e) | 2021-06-01-preview(main) |
| operations.json | 2023-05-01(6185f6e) | 2021-06-01(main) |
| operations.json | 2023-05-01(6185f6e) | 2021-06-01-preview(main) |
| privateEndpointConnections.json | 2023-05-01(6185f6e) | 2021-06-01(main) |
| privateEndpointConnections.json | 2023-05-01(6185f6e) | 2021-06-01-preview(main) |
| privateLinkResources.json | 2023-05-01(6185f6e) | 2021-06-01(main) |
| privateLinkResources.json | 2023-05-01(6185f6e) | 2021-06-01-preview(main) |
| privatelinkhub.json | 2023-05-01(6185f6e) | 2021-06-01(main) |
| privatelinkhub.json | 2023-05-01(6185f6e) | 2021-06-01-preview(main) |
| sqlPool.json | 2023-05-01(6185f6e) | 2021-06-01(main) |
| sqlPool.json | 2023-05-01(6185f6e) | 2021-06-01-preview(main) |
| sqlServer.json | 2023-05-01(6185f6e) | 2021-06-01(main) |
| sqlServer.json | 2023-05-01(6185f6e) | 2021-06-01-preview(main) |
| workspace.json | 2023-05-01(6185f6e) | 2021-06-01(main) |
| workspace.json | 2023-05-01(6185f6e) | 2021-06-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 |
|---|---|
| The new version does not support 'application/json' as a request body format. New: Microsoft.Synapse/stable/2023-05-01/azureADOnlyAuthentication.json#L64:9 Old: Microsoft.Synapse/preview/2021-06-01-preview/azureADOnlyAuthentication.json#L23:3 |
|
| The new version does not support 'application/json' as a request body format. New: Microsoft.Synapse/stable/2023-05-01/azureADOnlyAuthentication.json#L185:9 Old: Microsoft.Synapse/preview/2021-06-01-preview/azureADOnlyAuthentication.json#L23:3 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/start/operationstatuses/{integrationRuntimeOperationId}' removed or restructured? Old: Microsoft.Synapse/preview/2021-06-01-preview/integrationRuntime.json#L1333:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/stop/operationstatuses/{integrationRuntimeOperationId}' removed or restructured? Old: Microsoft.Synapse/preview/2021-06-01-preview/integrationRuntime.json#L1391:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/enableinteractivequery/operationstatuses/{integrationRuntimeOperationId}' removed or restructured? Old: Microsoft.Synapse/preview/2021-06-01-preview/integrationRuntime.json#L1449:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/dataWarehouseQueries' removed or restructured? Old: Microsoft.Synapse/preview/2021-06-01-preview/sqlPool.json#L5256:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/dataWarehouseQueries/{dataWarehouseQueriesId}/steps' removed or restructured? Old: Microsoft.Synapse/preview/2021-06-01-preview/sqlPool.json#L5311:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/trustedServiceByPassConfiguration/default' removed or restructured? Old: Microsoft.Synapse/preview/2021-06-01-preview/workspace.json#L885:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/checkDefaultStorageAccountStatus' removed or restructured? Old: Microsoft.Synapse/preview/2021-06-01-preview/workspace.json#L942:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/scopePools' removed or restructured? Old: Microsoft.Synapse/preview/2021-06-01-preview/workspace.json#L1002:5 |
|
| The new version adds a response code '202'. New: Microsoft.Synapse/stable/2023-05-01/firewallRule.json#L122:11 |
|
| The new version adds a response code '201'. New: Microsoft.Synapse/stable/2023-05-01/sqlPool.json#L702:11 |
|
| The '$ref' property points to different models in the old and new versions. New: Microsoft.Synapse/stable/2023-05-01/firewallRule.json#L174:13 Old: Microsoft.Synapse/preview/2021-06-01-preview/firewallRule.json#L171:13 |
|
| The '$ref' property points to different models in the old and new versions. New: Microsoft.Synapse/stable/2023-05-01/integrationRuntime.json#L708:13 Old: Microsoft.Synapse/preview/2021-06-01-preview/integrationRuntime.json#L708:13 |
|
| The '$ref' property points to different models in the old and new versions. New: synapse/common/v1/types.json#L14:9 Old: common-types/resource-management/v2/types.json#L332:9 |
|
| The '$ref' property points to different models in the old and new versions. New: synapse/common/v1/types.json#L44:11 Old: common-types/resource-management/v2/types.json#L307:11 |
|
| The 'required' status changed from the old version('False') to the new version('True'). New: synapse/common/v1/types.json#L13:7 Old: common-types/resource-management/v2/types.json#L331:7 |
|
| The 'required' status changed from the old version('False') to the new version('True'). New: synapse/common/v1/types.json#L28:7 Old: common-types/resource-management/v2/types.json#L288:7 |
|
| The new version has a different default value than the previous one. New: Microsoft.Synapse/stable/2023-05-01/sqlPool.json#L5369:9 Old: Microsoft.Synapse/preview/2021-06-01-preview/sqlPool.json#L5471:9 |
|
| The new version has a different default value than the previous one. New: Microsoft.Synapse/stable/2023-05-01/sqlPool.json#L5432:9 Old: Microsoft.Synapse/preview/2021-06-01-preview/sqlPool.json#L5533:9 |
|
| The new version has a different default value than the previous one. New: Microsoft.Synapse/stable/2023-05-01/sqlPool.json#L6213:9 Old: Microsoft.Synapse/preview/2021-06-01-preview/sqlPool.json#L6298:9 |
|
| The read only property has changed from 'true' to 'false'. New: synapse/common/v1/types.json#L29:9 Old: common-types/resource-management/v2/types.json#L289:9 |
|
| The read only property has changed from 'true' to 'false'. New: synapse/common/v1/types.json#L33:9 Old: common-types/resource-management/v2/types.json#L294:9 |
|
| The read only property has changed from 'true' to 'false'. New: synapse/common/v1/types.json#L37:9 Old: common-types/resource-management/v2/types.json#L299:9 |
|
| The read only property has changed from 'true' to 'false'. New: synapse/common/v1/types.json#L41:9 Old: common-types/resource-management/v2/types.json#L304:9 |
|
| The read only property has changed from 'true' to 'false'. New: Microsoft.Synapse/stable/2023-05-01/sqlPool.json#L5475:13 Old: Microsoft.Synapse/preview/2021-06-01-preview/sqlPool.json#L5571:13 |
|
| The new version has a different 'allOf' property than the previous one. New: Microsoft.Synapse/stable/2023-05-01/firewallRule.json#L174:13 Old: Microsoft.Synapse/preview/2021-06-01-preview/firewallRule.json#L171:13 |
|
| The new version is missing a property found in the old version. Was 'code' renamed or removed? New: synapse/common/v1/types.json#L13:7 Old: common-types/resource-management/v2/types.json#L288:7 |
|
| The new version is missing a property found in the old version. Was 'message' renamed or removed? New: synapse/common/v1/types.json#L13:7 Old: common-types/resource-management/v2/types.json#L288:7 |
|
| The new version is missing a property found in the old version. Was 'target' renamed or removed? New: synapse/common/v1/types.json#L13:7 Old: common-types/resource-management/v2/types.json#L288:7 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 2 Errors, 14 Warnings failed [Detail]
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| package-2023-05 | package-2023-05(6185f6e) | default(main) |
| package-composite-v2 | package-composite-v2(6185f6e) | package-composite-v2(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2023-05-01/listUsage.json#L72 |
RPC-Uri-V1-05 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2023-05-01/listUsage.json#L72 |
RPC-Uri-V1-05 |
| Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.Synapse/stable/2023-05-01/listUsage.json#L25 |
||
| Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.Synapse/stable/2023-05-01/listUsage.json#L25 |
||
| Based on the response model schema, operation 'Operations_GetSubscriptionQuotaAndUsage' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Synapse/stable/2023-05-01/listUsage.json#L25 |
||
| Based on the response model schema, operation 'Operations_GetSubscriptionQuotaAndUsage' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Synapse/stable/2023-05-01/listUsage.json#L25 |
||
| The summary and description values should not be same. Location: Microsoft.Synapse/stable/2023-05-01/listUsage.json#L25 |
||
| The summary and description values should not be same. Location: Microsoft.Synapse/stable/2023-05-01/listUsage.json#L25 |
||
| Not using the common-types defined parameter 'location'. Location: Microsoft.Synapse/stable/2023-05-01/listUsage.json#L33 |
||
| Not using the common-types defined parameter 'location'. Location: Microsoft.Synapse/stable/2023-05-01/listUsage.json#L33 |
||
| Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.Synapse/stable/2023-05-01/listUsage.json#L73 |
||
| Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.Synapse/stable/2023-05-01/listUsage.json#L73 |
||
| Based on the response model schema, operation 'Operations_GetWorkspaceQuotaAndUsage' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Synapse/stable/2023-05-01/listUsage.json#L73 |
||
| Based on the response model schema, operation 'Operations_GetWorkspaceQuotaAndUsage' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Synapse/stable/2023-05-01/listUsage.json#L73 |
||
| The summary and description values should not be same. Location: Microsoft.Synapse/stable/2023-05-01/listUsage.json#L73 |
||
| The summary and description values should not be same. Location: Microsoft.Synapse/stable/2023-05-01/listUsage.json#L73 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2023-05-01/azureADOnlyAuthentication.json#L24 |
|
The resource name parameter 'azureADOnlyAuthenticationName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2023-05-01/azureADOnlyAuthentication.json#L24 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2023-05-01/azureADOnlyAuthentication.json#L24 |
|
The resource name parameter 'azureADOnlyAuthenticationName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2023-05-01/azureADOnlyAuthentication.json#L24 |
|
200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.Synapse/stable/2023-05-01/azureADOnlyAuthentication.json#L74 |
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.Synapse/stable/2023-05-01/azureADOnlyAuthentication.json#L74 |
|
200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.Synapse/stable/2023-05-01/azureADOnlyAuthentication.json#L74 |
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.Synapse/stable/2023-05-01/azureADOnlyAuthentication.json#L74 |
|
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.Synapse/stable/2023-05-01/azureADOnlyAuthentication.json#L108 |
|
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.Synapse/stable/2023-05-01/azureADOnlyAuthentication.json#L108 |
|
A 202 response should include an Location response header. Location: Microsoft.Synapse/stable/2023-05-01/azureADOnlyAuthentication.json#L121 |
|
A 202 response should include an Location response header. Location: Microsoft.Synapse/stable/2023-05-01/azureADOnlyAuthentication.json#L121 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2023-05-01/azureADOnlyAuthentication.json#L148 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2023-05-01/azureADOnlyAuthentication.json#L148 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2023-05-01/bigDataPool.json#L24 |
|
The resource name parameter 'bigDataPoolName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2023-05-01/bigDataPool.json#L24 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2023-05-01/bigDataPool.json#L24 |
|
The resource name parameter 'bigDataPoolName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2023-05-01/bigDataPool.json#L24 |
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.Synapse/stable/2023-05-01/bigDataPool.json#L142 |
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.Synapse/stable/2023-05-01/bigDataPool.json#L142 |
|
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.Synapse/stable/2023-05-01/bigDataPool.json#L188 |
|
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.Synapse/stable/2023-05-01/bigDataPool.json#L188 |
|
A 202 response should include an Location response header. Location: Microsoft.Synapse/stable/2023-05-01/bigDataPool.json#L195 |
|
A 202 response should include an Location response header. Location: Microsoft.Synapse/stable/2023-05-01/bigDataPool.json#L195 |
|
The delete response body must be empty. Location: Microsoft.Synapse/stable/2023-05-01/bigDataPool.json#L255 |
|
The delete response body must be empty. Location: Microsoft.Synapse/stable/2023-05-01/bigDataPool.json#L255 |
|
A 202 response should include an Location response header. Location: Microsoft.Synapse/stable/2023-05-01/bigDataPool.json#L260 |
|
A 202 response should include an Location response header. Location: Microsoft.Synapse/stable/2023-05-01/bigDataPool.json#L260 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2023-05-01/bigDataPool.json#L291 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2023-05-01/bigDataPool.json#L291 |
️❌Avocado: 1 Errors, 2 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag. readme: specification/synapse/resource-manager/readme.md json: Microsoft.Synapse/stable/2023-05-01/integrationRuntime.json |
| The default tag contains multiple API versions swaggers. readme: specification/synapse/resource-manager/readme.md tag: specification/synapse/resource-manager/readme.md#tag-package-composite-v2 |
|
| The JSON file has a circular reference. readme: specification/synapse/resource-manager/readme.md json: Microsoft.Synapse/stable/2023-05-01/azureADOnlyAuthentication.json |
️️✔️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: 0 Errors, 0 Warnings failed [Detail]
️️✔️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.
|
Hi, @dhruvkatyal! Thank you for your pull request. To help get your PR merged: |
Swagger Generation Artifacts
|
Generated ApiView
|
ghost
added
the
|
Hi @dhruvkatyal! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. |
This was referenced Jun 29, 2023
This was referenced Jun 29, 2023
dhruvkatyal
force-pushed
the
dkatyal/testReadME
branch
from
191ba5e to
7aac430
Compare
Next Steps to MergeNext steps that must be taken to merge this PR:
|
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.
ARM (Control Plane) API Specification Update Pull Request
Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can request review from an ARM API Review board.
ARM API changes review
ARMReviewlabel.ARMReviewlabel, if appropriate.If this happens, proceed according to guidance given in GitHub comments also added by the automation.
Breaking change review
If you have any breaking changes as defined in the Breaking Change Policy,
follow the process outlined in the High-level Breaking Change Process doc.
Getting help
and https://aka.ms/ci-fix.