Manual trigger API alignment - mark mandatory param as required #20640
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, @loriatarms 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.9.7)] | new version | base version |
|---|---|---|
| AutomationRules.json | 2022-10-01-preview(1e01809) | 2022-08-01(main) |
| AutomationRules.json | 2022-10-01-preview(1e01809) | 2022-09-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version has new required property 'logicAppsResourceId' that was not found in the old version. New: Microsoft.SecurityInsights/preview/2022-10-01-preview/AutomationRules.json#L255:13 Old: Microsoft.SecurityInsights/preview/2022-09-01-preview/AutomationRules.json#L255:13 |
|
| The new version has new required property 'logicAppsResourceId' that was not found in the old version. New: Microsoft.SecurityInsights/preview/2022-10-01-preview/AutomationRules.json#L1182:5 Old: Microsoft.SecurityInsights/preview/2022-09-01-preview/AutomationRules.json#L1182:5 |
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-preview-2022-10 | package-preview-2022-10(1e01809) | package-preview-2022-10(release-securityinsights-Microsoft.SecurityInsights-2022-10-01-preview) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| 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-10-01-preview/AutomationRules.json#L1188 |
|
| 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-10-01-preview/AutomationRules.json#L1204 |
|
| 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-10-01-preview/AutomationRules.json#L1066 |
|
| 'incidentIdentifier' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2022-10-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-10-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-10-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-10-01-preview/AutomationRules.json#L332 |
|
| 'AutomationRuleBooleanCondition' 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-10-01-preview/AutomationRules.json#L342 |
|
| 'innerConditions' 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-10-01-preview/AutomationRules.json#L348 |
|
| 'AutomationRuleBooleanConditionSupportedOperator' 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-10-01-preview/AutomationRules.json#L359 |
|
| '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-10-01-preview/AutomationRules.json#L467 |
|
| '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-10-01-preview/AutomationRules.json#L499 |
|
| '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-10-01-preview/AutomationRules.json#L516 |
|
| 'AutomationRulePropertyArrayConditionSupportedArrayConditionType' 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-10-01-preview/AutomationRules.json#L527 |
|
| 'AutomationRulePropertyArrayConditionSupportedArrayType' 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-10-01-preview/AutomationRules.json#L544 |
|
| 'AutomationRulePropertyArrayValuesCondition' 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-10-01-preview/AutomationRules.json#L566 |
|
| 'itemConditions' 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-10-01-preview/AutomationRules.json#L575 |
|
| '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-10-01-preview/AutomationRules.json#L585 |
|
| '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-10-01-preview/AutomationRules.json#L607 |
|
| '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-10-01-preview/AutomationRules.json#L634 |
|
| '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-10-01-preview/AutomationRules.json#L989 |
|
| '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-10-01-preview/AutomationRules.json#L1001 |
|
| '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-10-01-preview/AutomationRules.json#L1009 |
|
| '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-10-01-preview/AutomationRules.json#L1018 |
|
| '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-10-01-preview/AutomationRules.json#L1043 |
|
| '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-10-01-preview/AutomationRules.json#L1046 |
|
| '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-10-01-preview/AutomationRules.json#L1052 |
|
| '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-10-01-preview/AutomationRules.json#L1111 |
|
| '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-10-01-preview/AutomationRules.json#L1148 |
|
| '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-10-01-preview/AutomationRules.json#L1182 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️SDK Track2 Validation: 3 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/1e0180913722041970477c30f7018ae95ae46212/specification/securityinsights/resource-manager/readme.md#tag-package-preview-2022-10">securityinsights/resource-manager/readme.md#package-preview-2022-10
| Rule | Message |
|---|---|
| "readme":"securityinsights/resource-manager/readme.md", "tag":"package-preview-2022-10", "details":"The schema 'components·1qaufw0·schemas·threatintelligenceindicatorproperties·properties·extensions·additionalproperties' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-10-01-preview/ThreatIntelligence.json#/components/schemas/components·1qaufw0·schemas·threatintelligenceindicatorproperties·properties·extensions·additionalproperties" |
|
| "readme":"securityinsights/resource-manager/readme.md", "tag":"package-preview-2022-10", "details":"The schema 'components·2sbdb2·schemas·watchlistitemproperties·properties·itemskeyvalue·additionalproperties' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-10-01-preview/Watchlists.json#/components/schemas/components·2sbdb2·schemas·watchlistitemproperties·properties·itemskeyvalue·additionalproperties" |
|
| "readme":"securityinsights/resource-manager/readme.md", "tag":"package-preview-2022-10", "details":"The schema 'components·84fvid·schemas·watchlistitemproperties·properties·entitymapping·additionalproperties' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-10-01-preview/Watchlists.json#/components/schemas/components·84fvid·schemas·watchlistitemproperties·properties·entitymapping·additionalproperties" |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| "readme":"securityinsights/resource-manager/readme.md", "tag":"package-preview-2022-10", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
Swagger Generation Artifacts
|
|
Hi, @loriatarms your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
Generated ApiView
|
loriatarms
changed the title
This was referenced Sep 8, 2022
This was referenced Sep 8, 2022
JeffreyRichter
added
the
Approved-BreakingChange
|
From @loriatarms : Due to a mistake, the latest preview versions are not aligned with the fix I done two months ago. |
mentat9
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
dw511214992
approved these changes
Sep 13, 2022
dw511214992
merged commit 58f2933
into
Azure:release-securityinsights-Microsoft.SecurityInsights-2022-10-01-preview
dw511214992
pushed a commit
that referenced
this pull request
Sep 28, 2022
#20858) * Adds base for updating Microsoft.SecurityInsights from version preview/2022-09-01-preview to version 2022-10-01-preview * Updates readme * Updates API version in new specs and examples * fix (#20640) * AlertRules- Add SentinelEntities and extend AlertDetailsOverride (#20645) * Add SentinelEntities and extend AlertDetailsOverride * Add SentinelEntities and extend AlertDetailsOverride * Entities 2022 10 01 preview added security alert timeline item intent and techniques (#20665) * Added SecurityAlertTimelineItem Intent and techiques * changed intent to enum * reran prettier Co-authored-by: Natanel Mizrahi <[email protected]> Co-authored-by: dosegal <[email protected]> Co-authored-by: loriatarms <[email protected]> Co-authored-by: necoh <[email protected]> Co-authored-by: nmizrahi6 <[email protected]> Co-authored-by: Natanel Mizrahi <[email protected]>
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.
-[x] 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.