Tarsharm/20200710 #22361
Draft
Tarsharm/20200710 #22361
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
|
Hi, @tarsharm 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 |
|---|---|---|
| migrate.json | 2020-07-10(55b6d70) | 2020-07-07(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 19 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/HyperVSites/{siteName}/refresh' removed or restructured? Old: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L1210:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/HyperVSites/{siteName}/summary' removed or restructured? Old: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L2614:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/VMwareSites/{siteName}/summary' removed or restructured? Old: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L2672:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/MasterSites' removed or restructured? Old: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L2730:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OffAzure/MasterSites' removed or restructured? Old: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L2779:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/MasterSites/{siteName}' removed or restructured? Old: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L2835:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateEndpointConnections/{peConnectionName}' removed or restructured? Old: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L3132:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateEndpointConnections' removed or restructured? Old: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L3335:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateLinkResources/{privateLinkResourceName}' removed or restructured? Old: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L3394:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateLinkResources' removed or restructured? Old: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L3460:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/VMwareSites' removed or restructured? Old: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L3519:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OffAzure/VMwareSites' removed or restructured? Old: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L3570:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/HyperVSites' removed or restructured? Old: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L3628:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OffAzure/HyperVSites' removed or restructured? Old: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L3679:5 |
|
The new version is missing a definition that was found in the old version. Was 'MasterSite' removed or renamed? New: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L6235:3 Old: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L3738:3 |
|
The new version is missing a definition that was found in the old version. Was 'MasterSiteProperties' removed or renamed? New: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L6235:3 Old: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L3738:3 |
|
The new version is missing a definition that was found in the old version. Was 'PrivateEndpointConnection' removed or renamed? New: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L6235:3 Old: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L3738:3 |
|
The new version is missing a definition that was found in the old version. Was 'PrivateEndpointConnectionProperties' removed or renamed? New: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L6235:3 Old: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L3738:3 |
|
The new version is missing a definition that was found in the old version. Was 'ResourceId' removed or renamed? New: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L6235:3 Old: Microsoft.OffAzure/stable/2020-07-07/migrate.json#L3738:3 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| default | default(55b6d70) | default(main) |
️❌Avocado: 333 Errors, 0 Warnings failed [Detail]
Only 19 items are listed, please refer to log for more details.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 0 Errors, 0 Warnings failed [Detail]
️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️️✔️~[Staging] CadlAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 50 Errors, 0 Warnings failed [Detail]
Only 19 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: 197 Errors, 0 Warnings failed [Detail]
Only 19 items are listed, please refer to log for more details.
️❌SpellCheck: 44 Errors, 0 Warnings failed [Detail]
Only 19 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Unknown word (deletejobs), please fix the error or add words to ./custom-words.txt path: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L1959:125 |
|
Unknown word (Deletejobs), please fix the error or add words to ./custom-words.txt path: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L1964:37 |
|
Unknown word (Deletejobs), please fix the error or add words to ./custom-words.txt path: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L1994:24 |
|
Unknown word (Deletejobs), please fix the error or add words to ./custom-words.txt path: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L1995:45 |
|
Unknown word (Deletejobs), please fix the error or add words to ./custom-words.txt path: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L1997:24 |
|
Unknown word (Deletejob), please fix the error or add words to ./custom-words.txt path: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L2008:37 |
|
Unknown word (Deletejob), please fix the error or add words to ./custom-words.txt path: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L2046:24 |
|
Unknown word (Deletejob), please fix the error or add words to ./custom-words.txt path: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L2047:45 |
|
Unknown word (Deletejob), please fix the error or add words to ./custom-words.txt path: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L2049:24 |
|
Unknown word (exportjobs), please fix the error or add words to ./custom-words.txt path: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L2114:125 |
|
Unknown word (Exportjobs), please fix the error or add words to ./custom-words.txt path: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L2119:37 |
|
Unknown word (Exportjobs), please fix the error or add words to ./custom-words.txt path: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L2149:24 |
|
Unknown word (Exportjobs), please fix the error or add words to ./custom-words.txt path: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L2150:45 |
|
Unknown word (Exportjobs), please fix the error or add words to ./custom-words.txt path: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L2152:24 |
|
Unknown word (Exportjob), please fix the error or add words to ./custom-words.txt path: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L2163:37 |
|
Unknown word (Exportjob), please fix the error or add words to ./custom-words.txt path: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L2201:24 |
|
Unknown word (Exportjob), please fix the error or add words to ./custom-words.txt path: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L2202:45 |
|
Unknown word (Exportjob), please fix the error or add words to ./custom-words.txt path: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L2204:24 |
|
Unknown word (importjobs), please fix the error or add words to ./custom-words.txt path: Microsoft.OffAzure/stable/2020-07-10/migrate.json#L2270:125 |
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️❌CadlValidation: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"details":"The swagger specification/migrate/resource-manager/Microsoft.OffAzure/stable/2020-07-10/migrate.json is generated from cadl files, but the cadl project with '@azure-tools/cadl-autorest' emitter is missing in the PR. Please add the missing cadl project or emitter configuration." |
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @tarsharm, 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. |
|
Hi, @tarsharm, 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. For more details refer to the wiki. Or you could onboard API spec pipeline |
This was referenced Jan 30, 2023
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.