Skip to content
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

release 2023 02 01 #22474

Merged

Conversation

anat-gilenson
Copy link
Contributor

Please note all PRs to this branch have already been reviewed and approved by Swagger team and ARM. No need for addition ARM review.

anat-gilenson and others added 7 commits January 3, 2023 19:59
…re#22196)

* add alert details override changes and PUT example

* add missing brace

* add closing brace for alertDetailsOverride

* add dynamic properties to 200 response

* add dynamic details to 201 response

---------

Co-authored-by: ShaniFelig <[email protected]>
* Release Metadata 2023-02-01 stable version.

* Fix Swagger spec validation errors.

* Revert Metadata service version to 2022-12-01-preview

* Bring back changes for version 2023-02-01
@openapi-workflow-bot
Copy link

Hi, @anat-gilenson Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 6, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️❌Breaking Change(Cross-Version): 68 Errors, 314 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    AlertRules.json 2023-02-01(2d7d423) 2022-11-01(main)
    AlertRules.json 2023-02-01(2d7d423) 2023-02-01-preview(main)
    AutomationRules.json 2023-02-01(2d7d423) 2022-11-01(main)
    AutomationRules.json 2023-02-01(2d7d423) 2023-02-01-preview(main)
    Bookmarks.json 2023-02-01(2d7d423) 2022-11-01(main)
    Bookmarks.json 2023-02-01(2d7d423) 2023-02-01-preview(main)
    DataConnectors.json 2023-02-01(2d7d423) 2022-11-01(main)
    Incidents.json 2023-02-01(2d7d423) 2022-11-01(main)
    Incidents.json 2023-02-01(2d7d423) 2023-02-01-preview(main)
    Metadata.json 2023-02-01(2d7d423) 2023-02-01-preview(main)
    OnboardingStates.json 2023-02-01(2d7d423) 2022-11-01(main)
    OnboardingStates.json 2023-02-01(2d7d423) 2023-02-01-preview(main)
    SecurityMLAnalyticsSettings.json 2023-02-01(2d7d423) 2022-11-01(main)
    SecurityMLAnalyticsSettings.json 2023-02-01(2d7d423) 2023-02-01-preview(main)
    ThreatIntelligence.json 2023-02-01(2d7d423) 2022-11-01(main)
    ThreatIntelligence.json 2023-02-01(2d7d423) 2023-02-01-preview(main)
    Watchlists.json 2023-02-01(2d7d423) 2022-11-01(main)
    Watchlists.json 2023-02-01(2d7d423) 2023-02-01-preview(main)
    AlertTypes.json 2023-02-01(2d7d423) 2022-11-01(main)
    AlertTypes.json 2023-02-01(2d7d423) 2023-02-01-preview(main)
    EntityTypes.json 2023-02-01(2d7d423) 2022-11-01(main)
    EntityTypes.json 2023-02-01(2d7d423) 2023-02-01-preview(main)
    IncidentTypes.json 2023-02-01(2d7d423) 2022-11-01(main)
    IncidentTypes.json 2023-02-01(2d7d423) 2023-02-01-preview(main)
    operations.json 2023-02-01(2d7d423) 2022-11-01(main)
    operations.json 2023-02-01(2d7d423) 2023-02-01-preview(main)

    The following breaking changes are detected by comparison with the latest stable version:

    Only 26 items are listed, please refer to log for more details.

    Rule Message
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: Microsoft.SecurityInsights/stable/2023-02-01/ThreatIntelligence.json#L49:9
    Old: Microsoft.SecurityInsights/stable/2022-11-01/ThreatIntelligence.json#L49:9
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11
    1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    Old: stable/2022-11-01/common/EntityTypes.json#L2272:11


    The following breaking changes are detected by comparison with the latest preview version:

    Only 26 items are listed, please refer to log for more details.

    Rule Message
    ⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentIdentifier}/runPlaybook' removed or restructured?
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/AutomationRules.json#L220:5
    ⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/relations' removed or restructured?
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/Bookmarks.json#L222:5
    ⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/expand' removed or restructured?
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/Bookmarks.json#L283:5
    ⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/relations/{relationName}' removed or restructured?
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/Bookmarks.json#L331:5
    ⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/createTeam' removed or restructured?
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/Incidents.json#L218:5
    ⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/tasks' removed or restructured?
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/Incidents.json#L856:5
    ⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/tasks/{incidentTaskId}' removed or restructured?
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/Incidents.json#L907:5
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'MLBehaviorAnalyticsAlertRule' removed or renamed?
    New: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L522:3
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/AlertRules.json#L577:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'MLBehaviorAnalyticsAlertRuleProperties' removed or renamed?
    New: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L522:3
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/AlertRules.json#L577:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'MLBehaviorAnalyticsAlertRuleTemplate' removed or renamed?
    New: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L522:3
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/AlertRules.json#L577:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ThreatIntelligenceAlertRule' removed or renamed?
    New: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L522:3
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/AlertRules.json#L577:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ThreatIntelligenceAlertRuleProperties' removed or renamed?
    New: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L522:3
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/AlertRules.json#L577:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ThreatIntelligenceAlertRuleTemplate' removed or renamed?
    New: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L522:3
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/AlertRules.json#L577:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'NrtAlertRuleProperties' removed or renamed?
    New: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L522:3
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/AlertRules.json#L577:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'NrtAlertRuleTemplate' removed or renamed?
    New: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L522:3
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/AlertRules.json#L577:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'NrtAlertRule' removed or renamed?
    New: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L522:3
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/AlertRules.json#L577:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'SentinelEntitiesMappings' removed or renamed?
    New: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L522:3
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/AlertRules.json#L577:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AddIncidentTaskActionProperties' removed or renamed?
    New: Microsoft.SecurityInsights/stable/2023-02-01/AutomationRules.json#L224:3
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/AutomationRules.json#L282:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AutomationRuleAddIncidentTaskAction' removed or renamed?
    New: Microsoft.SecurityInsights/stable/2023-02-01/AutomationRules.json#L224:3
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/AutomationRules.json#L282:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AutomationRuleBooleanCondition' removed or renamed?
    New: Microsoft.SecurityInsights/stable/2023-02-01/AutomationRules.json#L224:3
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/AutomationRules.json#L282:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AutomationRuleBooleanConditionSupportedOperator' removed or renamed?
    New: Microsoft.SecurityInsights/stable/2023-02-01/AutomationRules.json#L224:3
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/AutomationRules.json#L282:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AutomationRulePropertyArrayConditionSupportedArrayConditionType' removed or renamed?
    New: Microsoft.SecurityInsights/stable/2023-02-01/AutomationRules.json#L224:3
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/AutomationRules.json#L282:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AutomationRulePropertyArrayConditionSupportedArrayType' removed or renamed?
    New: Microsoft.SecurityInsights/stable/2023-02-01/AutomationRules.json#L224:3
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/AutomationRules.json#L282:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AutomationRulePropertyArrayValuesCondition' removed or renamed?
    New: Microsoft.SecurityInsights/stable/2023-02-01/AutomationRules.json#L224:3
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/AutomationRules.json#L282:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'BooleanConditionProperties' removed or renamed?
    New: Microsoft.SecurityInsights/stable/2023-02-01/AutomationRules.json#L224:3
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/AutomationRules.json#L282:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ManualTriggerRequestBody' removed or renamed?
    New: Microsoft.SecurityInsights/stable/2023-02-01/AutomationRules.json#L224:3
    Old: Microsoft.SecurityInsights/preview/2023-02-01-preview/AutomationRules.json#L282:3
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 1 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-2023-02 package-2023-02(2d7d423) default(main)

    [must fix]The following errors/warnings are introduced by current PR:

    Rule Message Related RPC [For API reviewers]
    ⚠️ DeprecatedXmsCodeGenerationSetting 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/stable/2023-02-01/AutomationRules.json#L7


    The following errors/warnings exist before current PR submission:

    Only 26 items are listed, please refer to log for more details.

    Rule Message
    DeleteResponseBodyEmpty The delete response body must be empty.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/AutomationRules.json#L151
    DeleteResponseBodyEmpty The delete response body must be empty.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/AutomationRules.json#L157
    GuidUsage Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/AutomationRules.json#L1001
    ResourceNameRestriction The resource name parameter 'relationName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/Incidents.json#L640
    ResourceNameRestriction The resource name parameter 'sentinelOnboardingStateName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/OnboardingStates.json#L37
    ResourceNameRestriction The resource name parameter 'settingsResourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/SecurityMLAnalyticsSettings.json#L82
    GuidUsage Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/SecurityMLAnalyticsSettings.json#L390
    PathForResourceAction Path for 'post' method on a resource type MUST follow valid resource naming.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/ThreatIntelligence.json#L37
    PostOperationAsyncResponseValidation Only 202 is the supported response code for POST async response.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/ThreatIntelligence.json#L73
    PathForResourceAction Path for 'post' method on a resource type MUST follow valid resource naming.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/ThreatIntelligence.json#L285
    PathForResourceAction Path for 'post' method on a resource type MUST follow valid resource naming.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/ThreatIntelligence.json#L375
    PathForResourceAction Path for 'post' method on a resource type MUST follow valid resource naming.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/ThreatIntelligence.json#L420
    RepeatedPathInfo The 'watchlistAlias' already appears in the path, please don't repeat it in the request body.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/Watchlists.json#L199
    RepeatedPathInfo The 'watchlistItemId' already appears in the path, please don't repeat it in the request body.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/Watchlists.json#L399
    ⚠️ PutRequestResponseScheme A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Actions_CreateOrUpdate' Request Model: 'parameters[6].schema' Response Model: 'responses[200].schema'
    Location: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L329
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L827
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L1027
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L1336
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L1353
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L1357
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L1469
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L1484
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/AutomationRules.json#L248
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/AutomationRules.json#L370
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/AutomationRules.json#L402
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.SecurityInsights/stable/2023-02-01/AutomationRules.json#L419
    ️️✔️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.

    ️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 6, 2023

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking


    azure-sdk-for-js - @azure/arm-securityinsight - 1.0.0-beta.7
    -	Type of parameter actionType of interface AutomationRuleAction is changed from "ModifyProperties" | "RunPlaybook" to "AddIncidentTask" | "ModifyProperties" | "RunPlaybook"
    -	Type of parameter kind of interface DataConnectorsCheckRequirements is changed from "AzureActiveDirectory" | "AzureAdvancedThreatProtection" | "AzureSecurityCenter" | "AmazonWebServicesCloudTrail" | "AmazonWebServicesS3" | "Dynamics365" | "MicrosoftCloudAppSecurity" | "MicrosoftDefenderAdvancedThreatProtection" | "MicrosoftThreatIntelligence" | "MicrosoftThreatProtection" | "OfficeATP" | "OfficeIRM" | "Office365Project" | "OfficePowerBI" | "ThreatIntelligence" | "ThreatIntelligenceTaxii" | "IOT" to "AzureActiveDirectory" | "AzureAdvancedThreatProtection" | "AzureSecurityCenter" | "AmazonWebServicesCloudTrail" | "AmazonWebServicesS3" | "Dynamics365" | "MicrosoftCloudAppSecurity" | "MicrosoftDefenderAdvancedThreatProtection" | "MicrosoftThreatIntelligence" | "MicrosoftThreatProtection" | "OfficeATP" | "OfficeIRM" | "MicrosoftPurviewInformationProtection" | "Office365Project" | "OfficePowerBI" | "ThreatIntelligence" | "ThreatIntelligenceTaxii" | "IOT"
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 4d150f8. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
      cmderr	[automation_generate.sh] npm notice
      cmderr	[automation_generate.sh] npm notice New major version of npm available! 8.19.3 -> 9.5.0
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.5.0>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-securityinsight [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation group AlertRuleOperations
      info	[Changelog]   - Added operation group GetTriggeredAnalyticsRuleRunsOperations
      info	[Changelog]   - Added operation group TriggeredAnalyticsRuleRunOperations
      info	[Changelog]   - Model MTPDataConnector has a new parameter filtered_providers
      info	[Changelog]   - Model MTPDataConnectorDataTypes has a new parameter alerts
      info	[Changelog]   - Model MTPDataConnectorProperties has a new parameter filtered_providers
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 4d150f8. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️@azure/arm-securityinsight [View full logs]  [Release SDK Changes] Breaking Change Detected
      Only show 120 items here, please refer to log for details.
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface CloudApplicationEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface DnsEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface EntityCommonProperties is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface EntityEdges is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter kind of interface EntityQueriesListOptionalParams is changed from Enum13 to Enum14
      info	[Changelog]   - Type of parameter additionalData of interface FileEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface FileHashEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface HostEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface HuntingBookmark is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface IoTDeviceEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface IpEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface MailboxEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface MailClusterEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface MailMessageEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface MalwareEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface NicEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface ProcessEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface RegistryKeyEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface RegistryValueEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface SecurityAlert is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface SecurityGroupEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface SubmissionMailEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface ThreatIntelligenceIndicatorModel is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Type of parameter additionalData of interface UrlEntity is changed from {
      info	[Changelog]         [propertyName: string]: Record<string, unknown>;
      info	[Changelog]     } to {
      info	[Changelog]         [propertyName: string]: any;
      info	[Changelog]     }
      info	[Changelog]   - Removed Enum KnownEnum13
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️❌ azure-resource-manager-schemas failed [Detail]
    • Failed [Logs]Release - Generate from 4d150f8. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh] WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
      warn	No file changes detected after generation
    • securityinsights/resource-manager [View full logs
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs]Release - Generate from 4d150f8. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    • Az.securityinsights [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 6, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Java azure-resourcemanager-securityinsights https://apiview.dev/Assemblies/Review/1bf21d2410eb494c9cccf8607d86f090
    .Net Azure.ResourceManager.SecurityInsights There is no API change compared with the previous version
    JavaScript @azure/arm-securityinsight https://apiview.dev/Assemblies/Review/35d6179023044784ab689fc6d3912def

    @openapi-workflow-bot
    Copy link

    Hi @anat-gilenson, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @openapi-workflow-bot
    Copy link

    Hi, @anat-gilenson, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline

    @openapi-workflow-bot
    Copy link

    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.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @zizw123
    Copy link

    zizw123 commented Feb 7, 2023

    This PR is labelled with breaking change, please get it reviewed first and then come back for ARM review

    @zizw123 zizw123 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Feb 7, 2023
    @openapi-workflow-bot
    Copy link

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Feb 7, 2023
    @dw511214992
    Copy link
    Member

    The changes in this PR is approved in other PRs, and this PR only aggreates them to merge to main branch. So we don't need to review it again.

    @dw511214992 dw511214992 added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Feb 22, 2023
    @dw511214992 dw511214992 merged commit 4d150f8 into Azure:main Feb 22, 2023
    aviyerMSFT pushed a commit to aviyerMSFT/azure-rest-api-specs that referenced this pull request Mar 22, 2023
    * Adds base for updating Microsoft.SecurityInsights from version stable/2022-11-01 to version 2023-02-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Provider sync properties (Azure#22198)
    
    * Alert Rules - add alert details override changes and PUT example (Azure#22196)
    
    * add alert details override changes and PUT example
    
    * add missing brace
    
    * add closing brace for alertDetailsOverride
    
    * add dynamic properties to 200 response
    
    * add dynamic details to 201 response
    
    ---------
    
    Co-authored-by: ShaniFelig <[email protected]>
    
    * Release Metadata 2023-02-01 stable version. (Azure#22161)
    
    * Release Metadata 2023-02-01 stable version.
    
    * Fix Swagger spec validation errors.
    
    * Revert Metadata service version to 2022-12-01-preview
    
    * Bring back changes for version 2023-02-01
    
    * Fix model validation
    
    ---------
    
    Co-authored-by: Dor Siso <[email protected]>
    Co-authored-by: ShaniFelig <[email protected]>
    Co-authored-by: ShaniFelig <[email protected]>
    Co-authored-by: Samuel Kuang <[email protected]>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-BreakingChange-JavaScript CI-MissingBaseCommit new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    7 participants