-
Notifications
You must be signed in to change notification settings - Fork 5k
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
Update automation rules alert trigger swagger #19388
Update automation rules alert trigger swagger #19388
Conversation
Hi, @dosiso 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 |
1 similar comment
Hi, @dosiso 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
|
Rule | Message |
---|---|
Guid used in model definition 'ManualTriggerRequestBody' for property 'tenantId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L1046 |
|
Guid used in model definition 'PlaybookActionProperties' for property 'tenantId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L1062 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isEnabled Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L954 |
|
'incidentIdentifier' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L246 |
|
'requestBody' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L252 |
|
'AutomationRule' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L306 |
|
'order' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L332 |
|
'AutomationRulePropertyArrayChangedConditionSupportedArrayType' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L428 |
|
'AutomationRulePropertyArrayChangedConditionSupportedChangeType' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L460 |
|
'AutomationRulePropertyArrayChangedValuesCondition' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L477 |
|
'AutomationRulePropertyChangedConditionSupportedChangedType' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L488 |
|
'AutomationRulePropertyChangedConditionSupportedPropertyType' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L510 |
|
'AutomationRulePropertyConditionSupportedOperator' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L537 |
|
'AutomationRulePropertyValuesChangedCondition' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L877 |
|
'propertyValues' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L889 |
|
'AutomationRulePropertyValuesCondition' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L897 |
|
'propertyValues' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L906 |
|
'AutomationRulesList' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L931 |
|
'value' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L934 |
|
'nextLink' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L940 |
|
'ConditionType' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L982 |
|
'IncidentPropertiesAction' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L1009 |
|
'ManualTriggerRequestBody' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L1043 |
|
'tenantId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L1046 |
|
'logicAppsResourceId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L1050 |
|
'PlaybookActionProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L1055 |
|
'triggersOn' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L1120 |
|
'triggersWhen' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-07-01-preview/AutomationRules.json#L1142 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
- Compared Swaggers (Based on Oad v0.9.5)
- current:preview/2022-07-01-preview/AutomationRules.json compared with base:stable/2021-10-01/AutomationRules.json
- current:preview/2022-07-01-preview/AutomationRules.json compared with base:preview/2022-06-01-preview/AutomationRules.json
️️✔️
SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
Hi, @dosiso your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
1 similar comment
Hi, @dosiso your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Please set the checkmarks correctly on the PR. This is not a new api version. This is an update to an existing version and does not need armreview |
@raosuhas |
Signing off. Can you please add this info in the PR going forward ? |
@dw511214992 can we move forward with merging this PR if no additional issues exist? |
* Adds base for updating Microsoft.SecurityInsights from version preview/2022-06-01-preview to version 2022-07-01-preview * Updates readme * Updates API version in new specs and examples * Added Nic entity type and IoT Device properties to EntityTypes.json (#19391) * added Nic entity type + modified IoTDevice props * updated GetIoTDeviceEntity example fields * ran prettier Co-authored-by: Natanel Mizrahi <natanel.mizrahi@gmail.com> * Update automation rules alert trigger swagger (#19388) Co-authored-by: nmizrahi6 <100570740+nmizrahi6@users.noreply.github.com> Co-authored-by: Natanel Mizrahi <natanel.mizrahi@gmail.com> Co-authored-by: Dor Siso <60354892+dosiso@users.noreply.github.com>
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:
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 appy 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 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.