Task 16820869: Remove subscription and resource group level test noti… #22279
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
…fication APIs in the new API version 2023-01-01
|
Hi, @thomasp98296 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. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| actionGroups_API.json | 2023-01-01(7b53bb3) | 2022-06-01(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Insights/createNotifications' removed or restructured? Old: Microsoft.Insights/stable/2022-06-01/actionGroups_API.json#L213:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/createNotifications' removed or restructured? Old: Microsoft.Insights/stable/2022-06-01/actionGroups_API.json#L268:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Insights/notificationStatus/{notificationId}' removed or restructured? Old: Microsoft.Insights/stable/2022-06-01/actionGroups_API.json#L387:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/notificationStatus/{notificationId}' removed or restructured? Old: Microsoft.Insights/stable/2022-06-01/actionGroups_API.json#L423:5 |
️❌CredScan: 0 Errors, 0 Warnings failed [Detail]
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2023-01 | package-2023-01(7b53bb3) | default(main) |
| package-preview-2022-08 | package-preview-2022-08(7b53bb3) | package-preview-2022-08(main) |
| package-composite-v1 | package-composite-v1(7b53bb3) | package-composite-v1(main) |
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 'actionGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L39 |
|
The resource name parameter 'actionGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L39 |
|
The resource name parameter 'actionGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L39 |
|
The resource name parameter 'actionGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L213 |
|
The resource name parameter 'actionGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L213 |
|
The resource name parameter 'actionGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L213 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'ActionGroups' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L220 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'ActionGroups' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L220 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'ActionGroups' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L220 |
|
The resource name parameter 'actionGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L274 |
|
The resource name parameter 'actionGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L274 |
|
The resource name parameter 'actionGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L274 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'ActionGroups' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L277 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'ActionGroups' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L277 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'ActionGroups' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L277 |
|
The resource name parameter 'actionGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L391 |
|
The resource name parameter 'actionGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L391 |
|
The resource name parameter 'actionGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L391 |
|
Property name should be camel case. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L519 |
|
Property name should be camel case. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L519 |
|
Property name should be camel case. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L519 |
|
Property name should be camel case. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L523 |
|
Property name should be camel case. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L523 |
|
Property name should be camel case. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L523 |
|
Property name should be camel case. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L527 |
|
Property name should be camel case. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L527 |
|
Property name should be camel case. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L527 |
|
Property name should be camel case. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L531 |
|
Property name should be camel case. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L531 |
|
Property name should be camel case. Location: Microsoft.Insights/stable/2023-01-01/actionGroups_API.json#L531 |
️❌Avocado: 4 Errors, 1 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Insights/createNotifications is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2022-06-01/actionGroups_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/createNotifications is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2022-06-01/actionGroups_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Insights/notificationStatus/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2022-06-01/actionGroups_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/notificationStatus/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2022-06-01/actionGroups_API.json |
| The default tag contains multiple API versions swaggers. readme: specification/monitor/resource-manager/readme.md tag: specification/monitor/resource-manager/readme.md#tag-package-preview-2022-08 |
️️✔️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 succeeded [Detail] [Expand]
️️✔️CadlAPIView 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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
ghost
added
the
AzureRestAPISpecReview
added
ARMReview
BreakingChangeReviewRequired
|
Hi @thomasp98296, 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 @thomasp98296, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi, @thomasp98296, 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 23, 2023
This was referenced Feb 10, 2023
@ArcturusZhang they already reviewed and approved here. Can we please proceed? Scenario 16406001: Remove Test Notifications APIs from ActionGroup RP |
mikekistler
added
the
Approved-BreakingChange
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
Please check this and update the PR, thanks |
zizw123
added
the
ARMChangesRequested
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
thomasp98296
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
thomasp98296
removed
the
WaitForARMFeedback
tadelesh
added
the
Approved-SdkBreakingChange-Go
|
Avocado is reporting that some APIs are missing and those are exactly the ones removed in this PR. Suppressed it since it is expected and approved |
ArcturusZhang
approved these changes
Feb 13, 2023
This was referenced Feb 13, 2023
aviyerMSFT
pushed a commit
to aviyerMSFT/azure-rest-api-specs
that referenced
this pull request
Mar 22, 2023
Azure#22279) * Task 16820869: Remove subscription and resource group level test notification APIs in the new API version 2023-01-01 * Update default version * Revert the default version * Update the default tag to include the new api version * Adding missing triple quotes --------- Co-authored-by: Thomas Pham <thompham@microsoft.com>
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.