[Hub Generated] Review request for Microsoft.Synapse to add version stable/2023-05-01 #23376
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, @dhruvkatyal 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. [email protected] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| types.json | 4.0(bc7f288) | 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(bc7f288) | 2021-06-01(main) |
| azureADOnlyAuthentication.json | 2023-05-01(bc7f288) | 2021-06-01-preview(main) |
| bigDataPool.json | 2023-05-01(bc7f288) | 2021-06-01(main) |
| bigDataPool.json | 2023-05-01(bc7f288) | 2021-06-01-preview(main) |
| checkNameAvailability.json | 2023-05-01(bc7f288) | 2021-06-01(main) |
| checkNameAvailability.json | 2023-05-01(bc7f288) | 2021-06-01-preview(main) |
| firewallRule.json | 2023-05-01(bc7f288) | 2021-06-01(main) |
| firewallRule.json | 2023-05-01(bc7f288) | 2021-06-01-preview(main) |
| integrationRuntime.json | 2023-05-01(bc7f288) | 2021-06-01(main) |
| integrationRuntime.json | 2023-05-01(bc7f288) | 2021-06-01-preview(main) |
| keys.json | 2023-05-01(bc7f288) | 2021-06-01(main) |
| keys.json | 2023-05-01(bc7f288) | 2021-06-01-preview(main) |
| library.json | 2023-05-01(bc7f288) | 2021-06-01(main) |
| library.json | 2023-05-01(bc7f288) | 2021-06-01-preview(main) |
| operations.json | 2023-05-01(bc7f288) | 2021-06-01(main) |
| operations.json | 2023-05-01(bc7f288) | 2021-06-01-preview(main) |
| privateEndpointConnections.json | 2023-05-01(bc7f288) | 2021-06-01(main) |
| privateEndpointConnections.json | 2023-05-01(bc7f288) | 2021-06-01-preview(main) |
| privateLinkResources.json | 2023-05-01(bc7f288) | 2021-06-01(main) |
| privateLinkResources.json | 2023-05-01(bc7f288) | 2021-06-01-preview(main) |
| privatelinkhub.json | 2023-05-01(bc7f288) | 2021-06-01(main) |
| privatelinkhub.json | 2023-05-01(bc7f288) | 2021-06-01-preview(main) |
| sqlPool.json | 2023-05-01(bc7f288) | 2021-06-01(main) |
| sqlPool.json | 2023-05-01(bc7f288) | 2021-06-01-preview(main) |
| sqlServer.json | 2023-05-01(bc7f288) | 2021-06-01(main) |
| sqlServer.json | 2023-05-01(bc7f288) | 2021-06-01-preview(main) |
| workspace.json | 2023-05-01(bc7f288) | 2021-06-01(main) |
| workspace.json | 2023-05-01(bc7f288) | 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: 1 Errors, 11 Warnings failed [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2023-05 | package-2023-05(bc7f288) | default(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 |
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Synapse/stable/2023-05-01/integrationRuntime.json#L2926 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Synapse/stable/2023-05-01/integrationRuntime.json#L2986 |
||
| 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 |
||
| The summary and description values should not be same. Location: Microsoft.Synapse/stable/2023-05-01/listUsage.json#L25 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition 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 |
||
| 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 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Synapse/stable/2023-05-01/listUsage.json#L81 |
||
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Subscription usage in given location Location: Microsoft.Synapse/stable/2023-05-01/listUsage.json#L112 |
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 |
|
An async PUT operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'azure-async-operation' on 'x-ms-long-running-operation-options' Location: Microsoft.Synapse/stable/2023-05-01/azureADOnlyAuthentication.json#L74 |
|
Only 201 is the supported response code for PUT async response. 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/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 |
|
An async PUT operation must return 201. Location: Microsoft.Synapse/stable/2023-05-01/bigDataPool.json#L188 |
|
Only 201 is the supported response code for PUT async response. 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 |
|
An async DELETE operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.Synapse/stable/2023-05-01/bigDataPool.json#L224 |
|
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 |
|
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/firewallRule.json#L24 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2023-05-01/firewallRule.json#L74 |
|
The resource name parameter 'ruleName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2023-05-01/firewallRule.json#L74 |
|
An async PUT operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'azure-async-operation' on 'x-ms-long-running-operation-options' Location: Microsoft.Synapse/stable/2023-05-01/firewallRule.json#L75 |
|
A 'put' operation 'IpFirewallRules_CreateOrUpdate' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201. Location: Microsoft.Synapse/stable/2023-05-01/firewallRule.json#L75 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.Synapse/stable/2023-05-01/firewallRule.json#L122 |
|
A 202 response should include an Location response header. Location: Microsoft.Synapse/stable/2023-05-01/firewallRule.json#L122 |
|
The delete response body must be empty. Location: Microsoft.Synapse/stable/2023-05-01/firewallRule.json#L174 |
|
A 202 response should include an Location response header. Location: Microsoft.Synapse/stable/2023-05-01/firewallRule.json#L182 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2023-05-01/firewallRule.json#L253 |
|
A 202 response should include an Location response header. Location: Microsoft.Synapse/stable/2023-05-01/firewallRule.json#L292 |
|
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.Synapse/stable/2023-05-01/firewallRule.json#L364 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2023-05-01/integrationRuntime.json#L24 |
|
The resource name parameter 'integrationRuntimeName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2023-05-01/integrationRuntime.json#L24 |
|
The property 'autoUpdate' in the request body either not apppear in the resource model or has the wrong level. Location: Microsoft.Synapse/stable/2023-05-01/integrationRuntime.json#L54 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| 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.
Swagger Generation Artifacts
|
Generated ApiView
|
ghost
added
the
This was referenced Mar 30, 2023
This was referenced Mar 30, 2023
|
/azp run unifiedPipeline |
|
No pipelines are associated with this pull request. |
|
/azp run unifiedPipeline |
|
No pipelines are associated with this pull request. |
|
/azp run unifiedPipeline |
|
No pipelines are associated with this pull request. |
|
/azp run unifiedPipeline |
|
No pipelines are associated with this pull request. |
|
/azp run unifiedPipeline |
|
No pipelines are associated with this pull request. |
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
@dhruvkatyal Please fix required CI item https://github.com/Azure/azure-rest-api-specs/pull/23376/checks?check_run_id=12696278643 with guidance #23376 (comment) |
|
The lintDiff seems also exist in previous PR like #22120. Is most of swagger content copied from last other api-version? |
Yes correct, we have added 2 new endpoints and the rest of APIs are all existing api. As per synapse RP standards all existing APIs should be supported in lastest version and so. |
Thanks for your review, Synapse workspace creation creates logical sql server with same name and so we have to follow same naming convention that sql follows, as per sql swagger spec they dont have any specified pattern and so we are also following the same |
|
approve swagger lintdiff for #23376 (comment) |
tadelesh
added
the
Approved-SdkBreakingChange-Go
|
Approved for Go breaking as they all come from tag change. |
msyyc
approved these changes
Apr 21, 2023
This was referenced Apr 21, 2023
Closed
Closed
vishnumathi
added a commit
to vishnumathi/azure-rest-api-specs
that referenced
this pull request
Apr 21, 2023
…ersion stable/2023-05-01 (Azure#23376)" This reverts commit 5b79bd5.
dhruvkatyal
restored the
dhruvkatyal-synapse-Microsoft.Synapse-2023-05-01
branch
suxi-ms
pushed a commit
that referenced
this pull request
Apr 24, 2023
…table/2023-05-01 (#23376) * Adds base for updating Microsoft.Synapse from version stable/2021-06-01 to version 2023-05-01 * Updates readme * Updates API version in new specs and examples * Fixing required failing validations * Adding ListUsage api spec * Removing redundant keys * minor correction * fixing validation * Addressing review comments * semantics fix --------- Co-authored-by: Dhruv Katyal <[email protected]>
JoshLove-msft
pushed a commit
to JoshLove-msft/azure-rest-api-specs
that referenced
this pull request
Apr 25, 2023
…table/2023-05-01 (Azure#23376) * Adds base for updating Microsoft.Synapse from version stable/2021-06-01 to version 2023-05-01 * Updates readme * Updates API version in new specs and examples * Fixing required failing validations * Adding ListUsage api spec * Removing redundant keys * minor correction * fixing validation * Addressing review comments * semantics fix --------- Co-authored-by: Dhruv Katyal <[email protected]>
JoshLove-msft
pushed a commit
to JoshLove-msft/azure-rest-api-specs
that referenced
this pull request
Apr 25, 2023
…ersion stable/2023-05-01 (Azure#23376)" (Azure#23668) This reverts commit 5b79bd5.
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.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
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.