[Hub Generated] Review request for Microsoft.DataMigration to add version preview/2022-11-30-preview #21952
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
…022-03-30-preview to version 2022-11-30-preview
|
Hi, @sergb213 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 tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2022-11 | package-preview-2022-11(6c026b2) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
The response in the GET collection operation 'Services_ListByResourceGroup' does not match the response definition in the individual GET operation 'Services_Get' . Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L18 |
|
|
The response in the GET collection operation 'Tasks_List' does not match the response definition in the individual GET operation 'Tasks_Get' . Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L18 |
|
|
The response in the GET collection operation 'ServiceTasks_List' does not match the response definition in the individual GET operation 'ServiceTasks_Get' . Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L18 |
|
|
The response in the GET collection operation 'Projects_List' does not match the response definition in the individual GET operation 'Projects_Get' . Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L18 |
|
|
The response in the GET collection operation 'Files_List' does not match the response definition in the individual GET operation 'Files_Get' . Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L18 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataMigration/preview/2022-11-30-preview/datamigration.json#L97 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.DataMigration/preview/2022-11-30-preview/datamigration.json#L130 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataMigration/preview/2022-11-30-preview/datamigration.json#L170 |
|
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataMigration/preview/2022-11-30-preview/datamigration.json#L293 |
|
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataMigration/preview/2022-11-30-preview/datamigration.json#L339 |
|
The response in the GET collection operation 'Tasks_List' does not match the response definition in the individual GET operation 'Tasks_Get' . Location: Microsoft.DataMigration/preview/2022-11-30-preview/datamigration.json#L432 |
|
The response in the GET collection operation 'ServiceTasks_List' does not match the response definition in the individual GET operation 'ServiceTasks_Get' . Location: Microsoft.DataMigration/preview/2022-11-30-preview/datamigration.json#L486 |
|
The response in the GET collection operation 'Services_ListByResourceGroup' does not match the response definition in the individual GET operation 'Services_Get' . Location: Microsoft.DataMigration/preview/2022-11-30-preview/datamigration.json#L584 |
|
The response in the GET collection operation 'Projects_List' does not match the response definition in the individual GET operation 'Projects_Get' . Location: Microsoft.DataMigration/preview/2022-11-30-preview/datamigration.json#L1157 |
|
The response in the GET collection operation 'Files_List' does not match the response definition in the individual GET operation 'Files_Get' . Location: Microsoft.DataMigration/preview/2022-11-30-preview/datamigration.json#L1449 |
|
The resource name parameter 'sqlDbInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L19 |
|
The resource name parameter 'targetDbName' should be defined with a 'pattern' restriction. Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L19 |
|
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L45 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L81 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L143 |
|
A 202 response should include an Location response header. Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L183 |
|
The resource name parameter 'sqlDbInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L198 |
|
The resource name parameter 'targetDbName' should be defined with a 'pattern' restriction. Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L198 |
|
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L199 |
|
A 202 response should include an Location response header. Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L241 |
|
The resource name parameter 'managedInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L253 |
|
The resource name parameter 'targetDbName' should be defined with a 'pattern' restriction. Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L253 |
|
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L279 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L315 |
|
The resource name parameter 'managedInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L378 |
|
The resource name parameter 'targetDbName' should be defined with a 'pattern' restriction. Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L378 |
|
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L379 |
|
A 202 response should include an Location response header. Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L421 |
|
The resource name parameter 'managedInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L433 |
|
The resource name parameter 'targetDbName' should be defined with a 'pattern' restriction. Location: Microsoft.DataMigration/preview/2022-11-30-preview/sqlmigration.json#L433 |
️❌Avocado: 3 Errors, 2 Warnings failed [Detail]
️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.DataMigration' for api version '2022-11-30-preview'. The supported api-versions are '2021-06-30, 2018-07-15-preview, 2018-04-19, 2018-03-31-preview, 2018-03-15-preview, 2017-11-15-preview, 2017-11-15-privatepreview, 2017-04-15-privatepreview, 2022-03-30-preview, 2022-01-30-preview, 2021-10-30-preview, 2020-09-01-preview'." |
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️❌~[Staging] SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️❌ModelValidation: 40 Errors, 0 Warnings failed [Detail]
Only 30 items are listed, please refer to log for more details.
️️✔️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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
ghost
added
the
This was referenced Dec 20, 2022
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @sergb213, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
11 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.
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.