Dev sentinel 2021 10 01 preview #17494
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
…w/2021-09-01-preview to version 2021-10-01-preview
* add Iot data connector * fix kind in getIotById * add deleted files * add missing newlines * fix newlines
…7173) * Adding providerIncidentUrl to Incident * Adding techniques to incident
* Bookmarks 2021-10-01-preview * prettier * definitions * rename Co-authored-by: Igal Shapira <igshapir@microsoft.com>
* Project and PowerBI specs added. * Space removed * File with a wrong name removed * More changer added * Example files with inconsistent naming removed * dataConnectors json updated * Ref fixed * Prettier applied Co-authored-by: Ido Klotz <idoklotz@microsoft.com>
* h * first * examples * prettier * path * fixes * prettier * examples * Z * Z * responses * fix * fixes * fix * prettier * PR Fixes * PR Fixes * PR Fixes * fix * fix * fix * fix * Last * PR Fixes * Last * tryFix * tryFix * incidentTypes * fix Co-authored-by: Roy Reinhorn <roreinho@microsoft.com>
* Update alert rules models with tactics and techniques * Add attack tactics new enum values * Update alert rules models examples * Fix techniques type * Update files with prettier * Insert validations fixes * Fix validations * Fixes in alert rules models * Fix alert rules models and examples * adding changes to alert rules json * Revert "adding changes to alert rules json" This reverts commit 603490e. * Adding fusion v2 ui api documentation * some fixes * adding prettier fixes * removing unwanted property * updating the readonly properties Co-authored-by: Lilyan Cohen <licohen@microsoft.com> Co-authored-by: Vishal Kumar <viskumar@microsoft.com>
Co-authored-by: Ido Klotz <idoklotz@microsoft.com>
|
Hi, @anat-gilenson 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 |
|
[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 Validation Report
|
| Rule | Message |
|---|---|
|
The new version is missing a property found in the old version. Was 'target' renamed or removed? New: resource-manager/common/2.0/types.json#L87:7 Old: common-types/resource-management/v3/types.json#L297:7 |
|
The new version is missing a property found in the old version. Was 'details' renamed or removed? New: resource-manager/common/2.0/types.json#L87:7 Old: common-types/resource-management/v3/types.json#L297:7 |
|
The new version is missing a property found in the old version. Was 'additionalInfo' renamed or removed? New: resource-manager/common/2.0/types.json#L87:7 Old: common-types/resource-management/v3/types.json#L297:7 |
️⚠️LintDiff: 27 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
Only 14 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| OperationId should contain the verb: 'runplaybook' in:'AutomationRules_ManualTriggerPlaybook'. Consider updating the operationId Location: Microsoft.SecurityInsights/preview/2021-10-01-preview/AutomationRules.json#L229 |
|
| 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/2021-10-01-preview/AutomationRules.json#L896 |
|
| 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/2021-10-01-preview/AutomationRules.json#L912 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.SecurityInsights/preview/2021-10-01-preview/AlertRules.json#L1051 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.SecurityInsights/preview/2021-10-01-preview/AlertRules.json#L1077 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isSupported Location: Microsoft.SecurityInsights/preview/2021-10-01-preview/AlertRules.json#L1106 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.SecurityInsights/preview/2021-10-01-preview/AlertRules.json#L1129 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isSupported Location: Microsoft.SecurityInsights/preview/2021-10-01-preview/AlertRules.json#L1250 |
|
| 'incidentIdentifier' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2021-10-01-preview/AutomationRules.json#L249 |
|
| 'requestBody' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.SecurityInsights/preview/2021-10-01-preview/AutomationRules.json#L255 |
|
| The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.SecurityInsights/preview/2021-10-01-preview/AutomationRules.json#L7 |
|
| '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/2021-10-01-preview/AutomationRules.json#L309 |
|
| '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/2021-10-01-preview/AutomationRules.json#L335 |
|
| '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/2021-10-01-preview/AutomationRules.json#L426 |
The following errors/warnings exist before current PR submission:
Only 14 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| Since operation 'Entities_Queries' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.SecurityInsights/preview/2021-10-01-preview/Entities.json#L291 |
|
| Since operation 'Entities_GetInsights' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.SecurityInsights/preview/2021-10-01-preview/Entities.json#L339 |
|
| Since operation 'ThreatIntelligenceIndicator_QueryIndicators' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.SecurityInsights/preview/2021-10-01-preview/ThreatIntelligence.json#L296 |
|
| Since operation 'Entities_Queries' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.SecurityInsights/preview/2021-09-01-preview/Entities.json#L291 |
|
| Since operation 'Entities_GetInsights' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.SecurityInsights/preview/2021-09-01-preview/Entities.json#L339 |
|
| Since operation 'ThreatIntelligenceIndicator_QueryIndicators' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.SecurityInsights/preview/2021-09-01-preview/ThreatIntelligence.json#L296 |
|
| 'GET' operation 'Entities_Queries' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.SecurityInsights/preview/2021-10-01-preview/Entities.json#L291 |
|
| 'GET' operation 'Entities_Queries' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.SecurityInsights/preview/2021-09-01-preview/Entities.json#L291 |
|
| 'PUT' operation 'ProductSettings_Update' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.SecurityInsights/preview/2021-10-01-preview/Settings.json#L176 |
|
| 'PUT' operation 'ProductSettings_Update' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.SecurityInsights/preview/2021-09-01-preview/Settings.json#L176 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.SecurityInsights/preview/2021-10-01-preview/Entities.json#L1030 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.SecurityInsights/preview/2021-10-01-preview/ThreatIntelligence.json#L1049 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.SecurityInsights/preview/2021-09-01-preview/Entities.json#L1030 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.SecurityInsights/preview/2021-09-01-preview/ThreatIntelligence.json#L1048 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌Cross-Version Breaking Changes: 130 Errors, 63 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.9.1)
- current:preview/2021-10-01-preview/AlertRules.json compared with base:stable/2020-01-01/AlertRules.json
- current:preview/2021-10-01-preview/AlertRules.json compared with base:preview/2021-09-01-preview/AlertRules.json
- current:preview/2021-10-01-preview/AutomationRules.json compared with base:preview/2021-09-01-preview/AutomationRules.json
- current:preview/2021-10-01-preview/Bookmarks.json compared with base:stable/2020-01-01/Bookmarks.json
- current:preview/2021-10-01-preview/Bookmarks.json compared with base:preview/2021-09-01-preview/Bookmarks.json
- current:preview/2021-10-01-preview/Enrichment.json compared with base:preview/2021-09-01-preview/Enrichment.json
- current:preview/2021-10-01-preview/Entities.json compared with base:preview/2021-09-01-preview/Entities.json
- current:preview/2021-10-01-preview/EntityQueries.json compared with base:preview/2021-09-01-preview/EntityQueries.json
- current:preview/2021-10-01-preview/EntityQueryTemplates.json compared with base:preview/2021-09-01-preview/EntityQueryTemplates.json
- current:preview/2021-10-01-preview/Incidents.json compared with base:stable/2021-04-01/Incidents.json
- current:preview/2021-10-01-preview/Incidents.json compared with base:preview/2021-09-01-preview/Incidents.json
- current:preview/2021-10-01-preview/Metadata.json compared with base:preview/2021-09-01-preview/Metadata.json
- current:preview/2021-10-01-preview/OfficeConsents.json compared with base:preview/2021-09-01-preview/OfficeConsents.json
- current:preview/2021-10-01-preview/OnboardingStates.json compared with base:preview/2021-09-01-preview/OnboardingStates.json
- current:preview/2021-10-01-preview/Settings.json compared with base:preview/2021-09-01-preview/Settings.json
- current:preview/2021-10-01-preview/SourceControls.json compared with base:preview/2021-09-01-preview/SourceControls.json
- current:preview/2021-10-01-preview/ThreatIntelligence.json compared with base:stable/2021-04-01/ThreatIntelligence.json
- current:preview/2021-10-01-preview/ThreatIntelligence.json compared with base:preview/2021-09-01-preview/ThreatIntelligence.json
- current:preview/2021-10-01-preview/Watchlists.json compared with base:stable/2021-04-01/Watchlists.json
- current:preview/2021-10-01-preview/Watchlists.json compared with base:preview/2021-09-01-preview/Watchlists.json
- current:2021-10-01-preview/common/AlertTypes.json compared with base:2021-09-01-preview/common/AlertTypes.json
- current:2021-10-01-preview/common/EntityTypes.json compared with base:2021-09-01-preview/common/EntityTypes.json
- current:2021-10-01-preview/common/IncidentTypes.json compared with base:2021-09-01-preview/common/IncidentTypes.json
- current:2021-10-01-preview/common/RelationTypes.json compared with base:2021-09-01-preview/common/RelationTypes.json
- current:2021-10-01-preview/common/ThreatIntelligenceTypes.json compared with base:2021-09-01-preview/common/ThreatIntelligenceTypes.json
- current:preview/2021-10-01-preview/dataConnectors.json compared with base:preview/2021-09-01-preview/dataConnectors.json
- current:preview/2021-10-01-preview/operations.json compared with base:stable/2021-04-01/operations.json
- current:preview/2021-10-01-preview/operations.json compared with base:preview/2021-09-01-preview/operations.json
Only 14 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}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/createIndicator' removed or restructured? Old: Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json#L37:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators' removed or restructured? Old: Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json#L91:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}' removed or restructured? Old: Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json#L151:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/queryIndicators' removed or restructured? Old: Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json#L300:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/metrics' removed or restructured? Old: Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json#L351:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}/appendTags' removed or restructured? Old: Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json#L396:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}/replaceTags' removed or restructured? Old: Microsoft.SecurityInsights/stable/2021-04-01/ThreatIntelligence.json#L444:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists' removed or restructured? Old: Microsoft.SecurityInsights/stable/2021-04-01/Watchlists.json#L37:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}' removed or restructured? Old: Microsoft.SecurityInsights/stable/2021-04-01/Watchlists.json#L88:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems' removed or restructured? Old: Microsoft.SecurityInsights/stable/2021-04-01/Watchlists.json#L240:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems/{watchlistItemId}' removed or restructured? Old: Microsoft.SecurityInsights/stable/2021-04-01/Watchlists.json#L294:5 |
|
The new version is missing a definition that was found in the old version. Was 'AlertRuleKind' removed or renamed? New: Microsoft.SecurityInsights/preview/2021-10-01-preview/AlertRules.json#L577:3 Old: Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json#L522:3 |
|
The new version is missing a definition that was found in the old version. Was 'AlertRuleTemplateStatus' removed or renamed? New: Microsoft.SecurityInsights/preview/2021-10-01-preview/AlertRules.json#L577:3 Old: Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json#L522:3 |
|
The new version is missing a definition that was found in the old version. Was 'AlertSeverity' removed or renamed? New: Microsoft.SecurityInsights/preview/2021-10-01-preview/AlertRules.json#L577:3 Old: Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json#L522:3 |
The following breaking changes are detected by comparison with latest preview version:
Only 14 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️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.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
|
Hi @anat-gilenson, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi @anat-gilenson, 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. |
|
@leni-msft |
leni-msft
added
the
Approved-BreakingChange
Co-authored-by: Ido Klotz <idoklotz@microsoft.com>
|
@anat-gilenson Please fix following validation errors in staging checks: SemanticValidation:
LintDiff:
|
leni-msft
added
the
Reviewed-ChangesRequested
leni-msft
approved these changes
Feb 7, 2022
This was referenced Feb 7, 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.
Merging 2021-10-01-preview dev branch to main. All PRs to this branch were reviewed and approved
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 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.