-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Alert simulator security microsoft.security 2021 01 01 #12614
Alert simulator security microsoft.security 2021 01 01 #12614
Conversation
https://github.com/yuvi123yuvi/azure-rest-api-specs into AlertSimulator-security-Microsoft.Security-2020-01-01 # Conflicts: # specification/security/resource-manager/readme.md
Hi, @yuvi123yuvi 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. vsswagger@microsoft.com |
Swagger Validation Report
|
Rule | Message |
---|---|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Security/stable/2021-01-01/alerts.json#L1002 |
️⚠️
Avocado: 1 Warnings warning [Detail]
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 |
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️
[Staging] Cross Version BreakingChange (Base on preview version): 27 Warnings warning [Detail]
Only 10 items are listed, please refer to log for more details.
- Compared Swaggers (Based on Oad v0.8.6)
- original: preview/2015-06-01-preview/alerts.json <---> new: stable/2021-01-01/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}/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}/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/2021-01-01/alerts.json#L1100: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/2021-01-01/alerts.json#L1100: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/2021-01-01/alerts.json#L1100: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/2021-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/2021-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/2021-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/2021-01-01/alerts.json#L248:7 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L284:7 |
|
The operation id has been changed from 'Alerts_UpdateSubscriptionLevelAlertStateToDismiss' to 'Alerts_UpdateSubscriptionLevelStateToDismiss'. This will impact generated code. New: Microsoft.Security/stable/2021-01-01/alerts.json#L293:7 Old: Microsoft.Security/preview/2015-06-01-preview/alerts.json#L329:7 |
️⚠️
[Staging] Cross Version BreakingChange (Base on stable version): 8 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.8.6)
- original: stable/2020-01-01/alerts.json <---> new: stable/2021-01-01/alerts.json
Rule | Message |
---|---|
The operation id has been changed from 'Alerts_ListSubscriptionLevelAlertsByRegion' to 'Alerts_ListSubscriptionLevelByRegion'. This will impact generated code. New: Microsoft.Security/stable/2021-01-01/alerts.json#L119:7 Old: Microsoft.Security/stable/2020-01-01/alerts.json#L119:7 |
|
The operation id has been changed from 'Alerts_ListResourceGroupLevelAlertsByRegion' to 'Alerts_ListResourceGroupLevelByRegion'. This will impact generated code. New: Microsoft.Security/stable/2021-01-01/alerts.json#L161:7 Old: Microsoft.Security/stable/2020-01-01/alerts.json#L161:7 |
|
The operation id has been changed from 'Alerts_GetSubscriptionLevelAlert' to 'Alerts_GetSubscriptionLevel'. This will impact generated code. New: Microsoft.Security/stable/2021-01-01/alerts.json#L206:7 Old: Microsoft.Security/stable/2020-01-01/alerts.json#L206:7 |
|
The operation id has been changed from 'Alerts_GetResourceGroupLevelAlerts' to 'Alerts_GetResourceGroupLevel'. This will impact generated code. New: Microsoft.Security/stable/2021-01-01/alerts.json#L248:7 Old: Microsoft.Security/stable/2020-01-01/alerts.json#L248:7 |
|
The operation id has been changed from 'Alerts_UpdateSubscriptionLevelAlertStateToDismiss' to 'Alerts_UpdateSubscriptionLevelStateToDismiss'. This will impact generated code. New: Microsoft.Security/stable/2021-01-01/alerts.json#L293:7 Old: Microsoft.Security/stable/2020-01-01/alerts.json#L293:7 |
|
The operation id has been changed from 'Alerts_UpdateSubscriptionLevelAlertStateToReactivate' to 'Alerts_UpdateSubscriptionLevelStateToActivate'. This will impact generated code. New: Microsoft.Security/stable/2021-01-01/alerts.json#L371:7 Old: Microsoft.Security/stable/2020-01-01/alerts.json#L371:7 |
|
The operation id has been changed from 'Alerts_UpdateResourceGroupLevelAlertStateToDismiss' to 'Alerts_UpdateResourceGroupLevelStateToDismiss'. This will impact generated code. New: Microsoft.Security/stable/2021-01-01/alerts.json#L452:7 Old: Microsoft.Security/stable/2020-01-01/alerts.json#L452:7 |
|
The operation id has been changed from 'Alerts_UpdateResourceGroupLevelAlertStateToReactivate' to 'Alerts_UpdateResourceGroupLevelStateToActivate'. This will impact generated code. New: Microsoft.Security/stable/2021-01-01/alerts.json#L494:7 Old: Microsoft.Security/stable/2020-01-01/alerts.json#L494:7 |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
[Staging] SDK Track2 Validation: 6 Errors, 33 Warnings failed [Detail]
Only 10 items are listed, please refer to log for more details.
- The following tags are being changed in this PR
Rule | Message |
---|---|
PreCheck/DuplicateSchema |
"readme":"security/resource-manager/readme.md", "tag":"package-composite-v3", "details":"Duplicate Schema named ExternalSecuritySolutionKind -- type: undefined => "string", properties: "kind":"description":"The kind of the external solution", "$ref":"#/components/schemas/ExternalSecuritySolutionKind" =>, enum: undefined => ["CEF", "ATA", "AAD"], x-ms-enum: undefined => "name":"ExternalSecuritySolutionKind", "modelAsString":true, "values":["value":"CEF", "value":"ATA", "value":"AAD"] ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
PreCheck/DuplicateSchema |
"readme":"security/resource-manager/readme.md", "tag":"package-composite-v3", "details":"Duplicate Schema named AadConnectivityState -- type: undefined => "string", properties: "connectivityState":"$ref":"#/components/schemas/AadConnectivityState" =>, title: undefined => "The connectivity state of the external AAD solution ", enum: undefined => ["Discovered", "NotLicensed", "Connected"], x-ms-enum: undefined => "name":"AadConnectivityState", "modelAsString":true, "values":["value":"Discovered", "value":"NotLicensed", "value":"Connected"] ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
AutorestCore/Exception |
"readme":"security/resource-manager/readme.md", "tag":"package-composite-v3", "details":"Error: Plugin prechecker reported failure." |
PreCheck/DuplicateSchema |
"readme":"security/resource-manager/readme.md", "tag":"package-2020-01-only", "details":"Duplicate Schema named ExternalSecuritySolutionKind -- type: undefined => "string", properties: "kind":"description":"The kind of the external solution", "$ref":"#/components/schemas/ExternalSecuritySolutionKind" =>, enum: undefined => ["CEF", "ATA", "AAD"], x-ms-enum: undefined => "name":"ExternalSecuritySolutionKind", "modelAsString":true, "values":["value":"CEF", "value":"ATA", "value":"AAD"] ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
PreCheck/DuplicateSchema |
"readme":"security/resource-manager/readme.md", "tag":"package-2020-01-only", "details":"Duplicate Schema named AadConnectivityState -- type: undefined => "string", properties: "connectivityState":"$ref":"#/components/schemas/AadConnectivityState" =>, title: undefined => "The connectivity state of the external AAD solution ", enum: undefined => ["Discovered", "NotLicensed", "Connected"], x-ms-enum: undefined => "name":"AadConnectivityState", "modelAsString":true, "values":["value":"Discovered", "value":"NotLicensed", "value":"Connected"] ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
AutorestCore/Exception |
"readme":"security/resource-manager/readme.md", "tag":"package-2020-01-only", "details":"Error: Plugin prechecker reported failure." |
"readme":"security/resource-manager/readme.md", "tag":"package-composite-v3", "details":"The schema 'ComplianceResultList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"security/resource-manager/readme.md", "tag":"package-composite-v3", "details":"The schema 'PricingList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"security/resource-manager/readme.md", "tag":"package-composite-v3", "details":"The schema 'AdvancedThreatProtectionProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"security/resource-manager/readme.md", "tag":"package-composite-v3", "details":"The schema 'TagsResource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
Hi @yuvi123yuvi, Your PR has some issues. Please fix the CI sequentially by following the order of
|
specification/security/resource-manager/Microsoft.Security/stable/2021-01-01/alerts.json
Show resolved
Hide resolved
specification/security/resource-manager/Microsoft.Security/stable/2021-01-01/alerts.json
Show resolved
Hide resolved
405b1d5
to
c19517d
Compare
As @yuvi123yuvi said, the validation seems false positive. Then, the PR is OK to merge. @yuvi123yuvi Please let me know when it ready to merge. |
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
* Alert Simulator * Added AlertSimulator * removed alert simulator * rebase squash * Added AlertSimulator * rebase squash * Fix * removing alert simulator from old API * removed example from old API * Updated response to be 202 * Added discriminator * Prettier * Prettier * readme fix * readme fix * readme fix * readme fix * readme fix * readme fix * Fixes * Fixes * Duplication fix * Added 2 new bundles * reverted change * Changed readme * Changed readme * Changed simulation kind to kind * Added x-ms-long-running-operation * Prettier Co-authored-by: t-yucohe <t-yucohe@microsoft.com>
Hi @yuvi123yuvi , With this setting, client side will try to visit this url with GET after the POST "Alerts_Simulate" operation. But actually there is no GET defined for this url. So want to know is there a GET interface in service side for this operation? Otherwise ["final-state-via": "original-uri"] should don't be defined in the "Alerts_Simulate". CC to @pilor . |
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from API 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.