release-securityinsights-Microsoft.SecurityInsights-2022-11-01-preview #21267
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/2022-10-01-preview to version 2022-11-01-preview
|
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. [email protected] |
Swagger Validation Report
|
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
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. |
This was referenced Oct 25, 2022
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.1)] | new version | base version |
|---|---|---|
| AlertRules.json | 2022-11-01-preview(0f7b70b) | 2022-08-01(main) |
| AlertRules.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| AutomationRules.json | 2022-11-01-preview(0f7b70b) | 2022-08-01(main) |
| AutomationRules.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| Bookmarks.json | 2022-11-01-preview(0f7b70b) | 2022-08-01(main) |
| Bookmarks.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| Enrichment.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| Entities.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| EntityQueries.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| EntityQueryTemplates.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| FileImports.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| Incidents.json | 2022-11-01-preview(0f7b70b) | 2022-08-01(main) |
| Incidents.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| Metadata.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| OfficeConsents.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| OnboardingStates.json | 2022-11-01-preview(0f7b70b) | 2022-08-01(main) |
| OnboardingStates.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| SecurityMLAnalyticsSettings.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| Settings.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| SourceControls.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| ThreatIntelligence.json | 2022-11-01-preview(0f7b70b) | 2022-08-01(main) |
| ThreatIntelligence.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| Watchlists.json | 2022-11-01-preview(0f7b70b) | 2022-08-01(main) |
| Watchlists.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| AlertTypes.json | 2022-11-01-preview(0f7b70b) | 2022-08-01(main) |
| AlertTypes.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| EntityTypes.json | 2022-11-01-preview(0f7b70b) | 2022-08-01(main) |
| EntityTypes.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| IncidentTypes.json | 2022-11-01-preview(0f7b70b) | 2022-08-01(main) |
| IncidentTypes.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| RelationTypes.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| ThreatIntelligenceTypes.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| dataConnectors.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
| operations.json | 2022-11-01-preview(0f7b70b) | 2022-08-01(main) |
| operations.json | 2022-11-01-preview(0f7b70b) | 2022-10-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 3 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-preview-2022-11 | package-preview-2022-11(0f7b70b) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Based on the response model schema, operation 'GetRecommendations_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.SecurityInsights/preview/2022-11-01-preview/Recommendations.json#L38 |
||
| Guid used in model definition 'Recommendation' for property 'id'. 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-11-01-preview/Recommendations.json#L176 |
||
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: visible Location: Microsoft.SecurityInsights/preview/2022-11-01-preview/Recommendations.json#L265 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.SecurityInsights/preview/2022-11-01-preview/EntityQueries.json#L484 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.SecurityInsights/preview/2022-11-01-preview/EntityQueryTemplates.json#L292 |
|
Missing identifier id in array item property Location: Microsoft.SecurityInsights/preview/2022-11-01-preview/Bookmarks.json#L566 |
|
Missing identifier id in array item property Location: Microsoft.SecurityInsights/preview/2022-11-01-preview/EntityQueryTemplates.json#L234 |
|
Missing identifier id in array item property Location: Microsoft.SecurityInsights/preview/2022-11-01-preview/Incidents.json#L1020 |
|
Missing identifier id in array item property Location: Microsoft.SecurityInsights/preview/2022-11-01-preview/Incidents.json#L1119 |
|
Missing identifier id in array item property Location: Microsoft.SecurityInsights/preview/2022-11-01-preview/Metadata.json#L581 |
|
Missing identifier id in array item property Location: Microsoft.SecurityInsights/preview/2022-11-01-preview/operations.json#L83 |
| Since operation 'EntitiesQueries' 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/2022-11-01-preview/Entities.json#L291 |
|
| Since operation 'EntitiesGetInsights' 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/2022-11-01-preview/Entities.json#L339 |
|
| Since operation 'ThreatIntelligenceIndicatorQueryIndicators' 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/2022-11-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/2022-11-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/2022-11-01-preview/Settings.json#L176 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.SecurityInsights/preview/2022-11-01-preview/Entities.json#L1114 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.SecurityInsights/preview/2022-11-01-preview/ThreatIntelligence.json#L1037 |
|
| Based on the response model schema, operation 'Entities_Queries' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.SecurityInsights/preview/2022-11-01-preview/Entities.json#L281 |
|
| Based on the response model schema, operation 'SentinelOnboardingStates_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.SecurityInsights/preview/2022-11-01-preview/OnboardingStates.json#L178 |
|
| Based on the response model schema, operation 'ProductSettings_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.SecurityInsights/preview/2022-11-01-preview/Settings.json#L38 |
|
| Based on the response model schema, operation 'ThreatIntelligenceIndicatorMetrics_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.SecurityInsights/preview/2022-11-01-preview/ThreatIntelligence.json#L334 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'BookmarkModel'. Consider using the plural form of 'Bookmark' to avoid this. 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/2022-11-01-preview/Bookmarks.json#L291 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'DataConnectorsCheckRequirementsModel'. Consider using the plural form of 'DataConnectorsCheckRequirements' to avoid this. 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/2022-11-01-preview/dataConnectors.json#L458 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SourceControlModel'. Consider using the plural form of 'SourceControl' to avoid this. 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/2022-11-01-preview/SourceControls.json#L48 |
|
| OperationId should contain the verb: 'dataconnectorscheckrequirements' in:'DataConnectorsCheckRequirements_Post'. Consider updating the operationId Location: Microsoft.SecurityInsights/preview/2022-11-01-preview/dataConnectors.json#L458 |
|
| OperationId should contain the verb: 'gettimeline' in:'EntitiesGetTimeline_list'. Consider updating the operationId Location: Microsoft.SecurityInsights/preview/2022-11-01-preview/Entities.json#L243 |
|
| The child tracked resource, 'relations' with immediate parent 'Bookmark', must have a list by immediate parent operation. Location: preview/2022-11-01-preview/common/RelationTypes.json#L30 |
|
| The child tracked resource, 'relations' with immediate parent 'Entity', must have a list by immediate parent operation. Location: preview/2022-11-01-preview/common/RelationTypes.json#L30 |
|
| The child tracked resource, 'relations' with immediate parent 'Incident', must have a list by immediate parent operation. Location: preview/2022-11-01-preview/common/RelationTypes.json#L30 |
|
| The child tracked resource, 'comments' with immediate parent 'Incident', must have a list by immediate parent operation. Location: Microsoft.SecurityInsights/preview/2022-11-01-preview/Incidents.json#L942 |
|
| The child tracked resource, 'watchlistItems' with immediate parent 'Watchlist', must have a list by immediate parent operation. Location: Microsoft.SecurityInsights/preview/2022-11-01-preview/Watchlists.json#L612 |
|
| 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-11-01-preview/AutomationRules.json#L1188 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌PoliCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Click detail for error messages. Exception contact [email protected] or https://aka.ms/swaggersupport. |
️️✔️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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
|
All changes have been reviewed in PR to the release branch. So don't need breaking change review again. |
dw511214992
approved these changes
Nov 7, 2022
dw511214992
deleted the
release-securityinsights-Microsoft.SecurityInsights-2022-11-01-preview
branch
This was referenced Nov 7, 2022
This was referenced Nov 7, 2022
anandanthony
pushed a commit
to anandMicro/azure-rest-api-specs
that referenced
this pull request
Dec 16, 2022
Azure#21267) * Adds base for updating Microsoft.SecurityInsights from version preview/2022-10-01-preview to version 2022-11-01-preview * Updates readme * Updates API version in new specs and examples * added recommendations specs (Azure#21118) * model validation fixes (Azure#21350) Co-authored-by: Vaspate <[email protected]> Co-authored-by: dosegal <[email protected]>
kayousef-zz
pushed a commit
to kayousef-zz/azure-rest-api-specs
that referenced
this pull request
Dec 21, 2022
Azure#21267) * Adds base for updating Microsoft.SecurityInsights from version preview/2022-10-01-preview to version 2022-11-01-preview * Updates readme * Updates API version in new specs and examples * added recommendations specs (Azure#21118) * model validation fixes (Azure#21350) Co-authored-by: Vaspate <[email protected]> Co-authored-by: dosegal <[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.
Please note all PRs to this branch have already been reviewed and approved by Swagger team and ARM. No need for addition ARM review.