Added Path and Properties #20887
Merged
Added Path and Properties #20887
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
12VamshiKrishna
requested review from
wonner and
yanjungao718
as code owners
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.7)] | new version | base version |
|---|---|---|
| kustoPool.json | 2021-06-01-preview(68490ea) | 2021-06-01-preview(main) |
| Rule | Message |
|---|---|
|
The new version is adding a path that was not found in the old version. New: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L2303:5 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 2 Errors, 2 Warnings failed [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-composite-v2 | package-composite-v2(68490ea) | package-composite-v2(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/privateEndpointConnections/{privateEndpointConnectionName} is missing. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L17 |
|
|
The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/privateEndpointConnections is missing. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L17 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'KustoPoolPrivateLinkResourcesModel'. Consider using the plural form of 'KustoPoolPrivateLinkResources' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L2308 |
||
| The resource 'KustoPoolPrivateLinkResources' does not have get operation, please add it. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L3939 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The parameters:workspaceName,kustoPoolName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L182 |
|
The parameters:workspaceName,resourceGroupName,kustoPoolName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L225 |
|
The parameters:workspaceName,resourceGroupName,kustoPoolName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L300 |
|
The parameters:workspaceName,resourceGroupName,kustoPoolName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L367 |
|
The parameters:workspaceName,kustoPoolName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L416 |
|
The parameters:workspaceName,kustoPoolName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L462 |
|
The parameters:workspaceName,kustoPoolName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L508 |
|
The parameters:workspaceName,kustoPoolName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L556 |
|
The parameters:workspaceName,kustoPoolName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L614 |
|
The parameters:workspaceName,kustoPoolName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L662 |
|
The parameters:workspaceName,kustoPoolName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L717 |
|
The parameters:workspaceName,kustoPoolName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L772 |
|
The parameters:workspaceName,kustoPoolName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L820 |
|
The parameters:workspaceName,kustoPoolName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L875 |
|
The parameters:workspaceName,kustoPoolName,attachedDatabaseConfigurationName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L923 |
|
The parameters:workspaceName,kustoPoolName,attachedDatabaseConfigurationName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L969 |
|
The parameters:workspaceName,kustoPoolName,attachedDatabaseConfigurationName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L1037 |
|
The parameters:workspaceName,kustoPoolName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L1765 |
|
The parameters:workspaceName,kustoPoolName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L1819 |
|
The parameters:workspaceName,kustoPoolName,principalAssignmentName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L1867 |
|
The parameters:workspaceName,kustoPoolName,principalAssignmentName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L1913 |
|
The parameters:workspaceName,kustoPoolName,principalAssignmentName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L1975 |
|
The parameters:workspaceName,kustoPoolName,databaseName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L2027 |
|
The parameters:workspaceName,kustoPoolName,databaseName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L2084 |
|
The parameters:workspaceName,kustoPoolName,databaseName,principalAssignmentName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L2135 |
|
The parameters:workspaceName,kustoPoolName,databaseName,principalAssignmentName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L2184 |
|
The parameters:workspaceName,kustoPoolName,databaseName,principalAssignmentName,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L2249 |
|
Missing identifier id in array item property Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L2357 |
|
Missing identifier id in array item property Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L2431 |
|
Missing identifier id in array item property Location: Microsoft.Synapse/preview/2021-06-01-preview/kustoPool.json#L2468 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| 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 |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️⚠️~[Staging] TrafficValidation: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️❌ModelValidation: 6 Errors, 0 Warnings failed [Detail]
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️SDK Track2 Validation: 3 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/68490ea480423eced4a2ca074e1c3029e3edd8ff/specification/synapse/resource-manager/readme.md#tag-package-composite-v2">synapse/resource-manager/readme.md#package-composite-v2
| Rule | Message |
|---|---|
| "readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Duplicate Schema named 'PrivateEndpointConnectionForPrivateLinkHubBasic' (5 differences):\n - properties.id.$ref: "#/components/schemas/schemas:93" => "#/components/schemas/schemas:1476"\n - properties.id.description: "identifier" =>\n - properties.id.readOnly: true =>\n - properties.properties.description: "Properties of private endpoint connection for private link hub" =>\n - properties.properties.x-ms-client-flatten: true =>" |
|
| "readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Duplicate Schema named 'ErrorResponse' (7 differences):\n - title: "Error response" => "Error Response"\n - properties.error: "description":"The error object.", "$ref":"#/components/schemas/schemas:1316" =>\n - properties.code: => "$ref":"#/components/schemas/schemas:1540", "description":"The error code.", "readOnly":true\n - properties.message: => "$ref":"#/components/schemas/schemas:1541", "description":"The error message.", "readOnly":true\n - properties.target: => "$ref":"#/components/schemas/schemas:1542", "description":"The error target.", "readOnly":true\n - properties.details: => "x-ms-identifiers":["message", "target"], "$ref":"#/components/schemas/schemas:1543", "description":"The error details.", "readOnly":true\n - properties.additionalInfo: => "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:1544", "description":"The error additional info.", "readOnly":true" |
|
| "readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"The schema 'KekIdentityProperties-useSystemAssignedIdentity' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/workspace.json#/components/schemas/KekIdentityProperties-useSystemAssignedIdentity" |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| "readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Schema 'ReplicationLink' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from ReplicationLink" |
|
| "readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Deduplicating schema name: 'SecurityAlertPolicyName' -> 'SecurityAlertPolicyNameAutoGenerated'" |
|
| "readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Deduplicating schema name: 'ErrorResponse' -> 'ErrorResponseAutoGenerated'" |
|
| "readme":"synapse/resource-manager/readme.md", "tag":"package-composite-v2", "details":"Deduplicating schema name: 'PrivateEndpointConnectionForPrivateLinkHubBasic' -> 'PrivateEndpointConnectionForPrivateLinkHubBasicAutoGenerated'" |
️️✔️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
|
ghost
added
the
AzureRestAPISpecReview
added
ARMReview
resource-manager
SuppressionReviewRequired
WaitForARMFeedback
This was referenced Sep 27, 2022
Closed
Closed
added 2 commits
September 27, 2022 21:33
|
NewApiVersionRequired reason: |
added 3 commits
September 29, 2022 16:04
|
Approving breaking change as it corrects an omission in the REST API definition. |
mikekistler
added
the
Approved-BreakingChange
bansalaseem
approved these changes
Sep 30, 2022
bansalaseem
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
@12VamshiKrishna , can you fix |
Those errors for API-/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/kustoPools/{kustoPoolName}/privateEndpointConnections Which are not my file changes. |
ruowan
approved these changes
Oct 6, 2022
ruowan
approved these changes
Oct 6, 2022
This was referenced Oct 6, 2022
Closed
anandanthony
pushed a commit
to anandMicro/azure-rest-api-specs
that referenced
this pull request
Dec 16, 2022
* Added Path and Properties * Path order * Example changes * members change * Changes * Path Order * params Co-authored-by: VamshiKrishna Chirra (Quadrant Resource) <[email protected]>
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 API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.