Creating new API version for Alerts API #17877
Merged
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, @yibirnba 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 pipeline can not start as the pull request has merge conflicts. |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
|
Swagger pipeline can not start as the pull request has merge conflicts. |
|
Swagger pipeline can not start as the pull request has merge conflicts. |
1 similar comment
|
Swagger pipeline can not start as the pull request has merge conflicts. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/security/resource-manager/readme.md tag: specification/security/resource-manager/readme.md#tag-package-composite-v3 |
️🔄~[Staging] ApiReadinessCheck inProgress [Detail]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌Cross-Version Breaking Changes: 8 Errors, 40 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.9.3)
- current:stable/2022-01-01/alerts.json compared with base:stable/2021-01-01/alerts.json
- current:stable/2022-01-01/alerts.json compared with base:preview/2015-06-01-preview/alerts.json
| Rule | Message |
|---|---|
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}/dismiss' removed or restructured? Old: Microsoft.Security/stable/2021-01-01/alerts.json#L292:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}/resolve' removed or restructured? Old: Microsoft.Security/stable/2021-01-01/alerts.json#L331:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}/activate' removed or restructured? Old: Microsoft.Security/stable/2021-01-01/alerts.json#L370:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}/resolve' removed or restructured? Old: Microsoft.Security/stable/2021-01-01/alerts.json#L409:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}/dismiss' removed or restructured? Old: Microsoft.Security/stable/2021-01-01/alerts.json#L451:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}/activate' removed or restructured? Old: Microsoft.Security/stable/2021-01-01/alerts.json#L493:5 |
|
The new version adds a response code '204'. New: Microsoft.Security/stable/2022-01-01/alerts.json#L566:11 |
|
The new version is removing enum value(s) 'Resolved, Dismissed' from the old version. New: Microsoft.Security/stable/2022-01-01/alerts.json#L832:9 Old: Microsoft.Security/stable/2021-01-01/alerts.json#L831:9 |
The following breaking changes are detected by comparison with latest preview version:
Only 30 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}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}/dismiss' removed or restructured? Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L328:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}/reactivate' removed or restructured? Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L367:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}/dismiss' removed or restructured? Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L406:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}/reactivate' removed or restructured? Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L448:5 |
|
| The new version is missing a client parameter that was found in the old version. Was 'ODataExpand' removed or renamed? New: Microsoft.Security/stable/2022-01-01/alerts.json#L1139:3 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L710:3 |
|
| The new version is missing a client parameter that was found in the old version. Was 'ODataSelect' removed or renamed? New: Microsoft.Security/stable/2022-01-01/alerts.json#L1139:3 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L710:3 |
|
| The new version is missing a client parameter that was found in the old version. Was 'ODataFilter' removed or renamed? New: Microsoft.Security/stable/2022-01-01/alerts.json#L1139:3 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L710:3 |
|
| The operation id has been changed from 'Alerts_ListSubscriptionLevelAlertsByRegion' to 'Alerts_ListSubscriptionLevelByRegion'. This will impact generated code. New: Microsoft.Security/stable/2022-01-01/alerts.json#L119:7 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L137:7 |
|
| The operation id has been changed from 'Alerts_ListResourceGroupLevelAlertsByRegion' to 'Alerts_ListResourceGroupLevelByRegion'. This will impact generated code. New: Microsoft.Security/stable/2022-01-01/alerts.json#L161:7 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L188:7 |
|
| The operation id has been changed from 'Alerts_GetSubscriptionLevelAlert' to 'Alerts_GetSubscriptionLevel'. This will impact generated code. New: Microsoft.Security/stable/2022-01-01/alerts.json#L206:7 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L242:7 |
|
| The operation id has been changed from 'Alerts_GetResourceGroupLevelAlerts' to 'Alerts_GetResourceGroupLevel'. This will impact generated code. New: Microsoft.Security/stable/2022-01-01/alerts.json#L248:7 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L284:7 |
|
| The new version has a different type 'array' than the previous one 'string'. New: Microsoft.Security/stable/2022-01-01/alerts.json#L818:9 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L565:9 |
|
| The new version has a different type 'string' than the previous one 'object'. New: Microsoft.Security/stable/2022-01-01/alerts.json#L619:7 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L706:7 |
|
| The read only property has changed from 'false' to 'true'. New: Microsoft.Security/stable/2022-01-01/alerts.json#L891:9 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L632:9 |
|
| The new version is missing a property found in the old version. Was 'state' renamed or removed? New: Microsoft.Security/stable/2022-01-01/alerts.json#L645:7 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L527:7 |
|
| The new version is missing a property found in the old version. Was 'reportedTimeUtc' renamed or removed? New: Microsoft.Security/stable/2022-01-01/alerts.json#L645:7 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L527:7 |
|
| The new version is missing a property found in the old version. Was 'alertName' renamed or removed? New: Microsoft.Security/stable/2022-01-01/alerts.json#L645:7 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L527:7 |
|
| The new version is missing a property found in the old version. Was 'detectedTimeUtc' renamed or removed? New: Microsoft.Security/stable/2022-01-01/alerts.json#L645:7 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L527:7 |
|
| The new version is missing a property found in the old version. Was 'actionTaken' renamed or removed? New: Microsoft.Security/stable/2022-01-01/alerts.json#L645:7 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L527:7 |
|
| The new version is missing a property found in the old version. Was 'reportedSeverity' renamed or removed? New: Microsoft.Security/stable/2022-01-01/alerts.json#L645:7 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L527:7 |
|
| The new version is missing a property found in the old version. Was 'associatedResource' renamed or removed? New: Microsoft.Security/stable/2022-01-01/alerts.json#L645:7 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L527:7 |
|
| The new version is missing a property found in the old version. Was 'systemSource' renamed or removed? New: Microsoft.Security/stable/2022-01-01/alerts.json#L645:7 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L527:7 |
|
| The new version is missing a property found in the old version. Was 'canBeInvestigated' renamed or removed? New: Microsoft.Security/stable/2022-01-01/alerts.json#L645:7 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L527:7 |
|
| The new version is missing a property found in the old version. Was 'confidenceScore' renamed or removed? New: Microsoft.Security/stable/2022-01-01/alerts.json#L645:7 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L527:7 |
|
| The new version is missing a property found in the old version. Was 'confidenceReasons' renamed or removed? New: Microsoft.Security/stable/2022-01-01/alerts.json#L645:7 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L527:7 |
|
| The new version is missing a property found in the old version. Was 'subscriptionId' renamed or removed? New: Microsoft.Security/stable/2022-01-01/alerts.json#L645:7 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L527:7 |
|
| The new version is missing a property found in the old version. Was 'instanceId' renamed or removed? New: Microsoft.Security/stable/2022-01-01/alerts.json#L645:7 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L527:7 |
|
| The new version is missing a property found in the old version. Was 'workspaceArmId' renamed or removed? New: Microsoft.Security/stable/2022-01-01/alerts.json#L645:7 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L527:7 |
|
| The optional parameter '$filter' was removed in the new version. Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L49:9 |
|
| The optional parameter '$select' was removed in the new version. Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L49:9 |
️⌛CredScan pending [Detail]
️🔄SDK Track2 Validation inProgress [Detail]
️️✔️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).
Swagger Generation Artifacts
|
|
Hi, @yibirnba your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi @yibirnba, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Feb 16, 2022
|
Hi @ruowan , This changes and fix the swagger to what we implemented from the start, currently the SDK throws an exception when using this method. How can we get an exemption for this specific validation? |
|
Pls fix semantic error first. |
yibirnba
removed request for
circy9,
kjeur,
Sandido,
dkulkarni-ms,
haagha,
madewithsmiles,
MS-syh2qs,
grizzlytheodore,
hyonholee,
jorinmejia,
yunheMsft,
t-bzhan,
wilcobmsft,
asarkar84,
paterasMSFT,
dpwatrous,
stankovski and
solankisamir
This was referenced Aug 3, 2022
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
April
April
Contribution checklist:
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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.