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

Change incidents api to generated swagger file #21509

Conversation

ityankel
Copy link
Contributor

@ityankel ityankel commented Nov 10, 2022

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:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

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.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] 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.

@openapi-workflow-bot
Copy link

Hi, @ityankel 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. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Nov 10, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️❌Breaking Change(Cross-Version): 24 Errors, 9 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.2)] new version base version
    Incidents.json 2022-12-01-preview(a00a306) 2022-08-01(main)
    Incidents.json 2022-12-01-preview(a00a306) 2022-11-01-preview(main)

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

    Rule Message
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L1053:9
    Old: Microsoft.SecurityInsights/stable/2022-08-01/Incidents.json#L1049:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L271:5
    Old: stable/2022-08-01/common/EntityTypes.json#L269:5
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: preview/2022-12-01-preview/common/EntityTypes.json#L240:9
    Old: stable/2022-08-01/common/EntityTypes.json#L240:9
    ⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
    New: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L1106:9
    Old: Microsoft.SecurityInsights/stable/2022-08-01/Incidents.json#L1091:9
    ⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
    New: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L1110:9
    Old: Microsoft.SecurityInsights/stable/2022-08-01/Incidents.json#L1127:9
    ⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
    New: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L1103:9
    Old: Microsoft.SecurityInsights/stable/2022-08-01/Incidents.json#L1224:9


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

    Rule Message
    ⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
    New: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L228:9
    Old: Microsoft.SecurityInsights/preview/2022-11-01-preview/Incidents.json#L246:9
    ⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
    New: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L1302:7
    Old: Microsoft.SecurityInsights/preview/2022-11-01-preview/Incidents.json#L1296:7
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'teamName' renamed or removed?
    Old: Microsoft.SecurityInsights/preview/2022-11-01-preview/Incidents.json#L246:9
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'teamDescription' renamed or removed?
    Old: Microsoft.SecurityInsights/preview/2022-11-01-preview/Incidents.json#L246:9
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'memberIds' renamed or removed?
    Old: Microsoft.SecurityInsights/preview/2022-11-01-preview/Incidents.json#L246:9
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'groupIds' renamed or removed?
    Old: Microsoft.SecurityInsights/preview/2022-11-01-preview/Incidents.json#L246:9
    ️⚠️LintDiff: 3 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-preview-2022-12 package-preview-2022-12(a00a306) package-preview-2022-12(release-securityinsights-Microsoft.SecurityInsights-2022-12-01-preview)

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

    Rule Message Related RPC [For API reviewers]
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L858
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L976
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L1084


    The following errors/warnings exist before current PR submission:

    Rule Message
    ResourceNameRestriction The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L9
    ResourceNameRestriction The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L69
    ResourceNameRestriction The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L218
    ResourceNameRestriction The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L269
    ResourceNameRestriction The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L317
    ResourceNameRestriction The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L365
    ResourceNameRestriction The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L428
    ResourceNameRestriction The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L586
    GetCollectionResponseSchema The response in the GET collection operation 'IncidentRelations_List' does not match the response definition in the individual GET operation 'IncidentRelations_Get' .
    Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L634
    ResourceNameRestriction The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L634
    ResourceNameRestriction The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L698
    ResourceNameRestriction The resource name parameter 'relationName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L698
    XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L1036
    XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L1123
    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/preview/2022-12-01-preview/Incidents.json#L1244
    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/preview/2022-12-01-preview/Incidents.json#L1252
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️❌~[Staging] SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️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 Nov 10, 2022

    Swagger Generation Artifacts

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

    Breaking Changes Tracking


    ⚠️azure-sdk-for-js - @azure/arm-securityinsight - 1.0.0-beta.6
    +	Operation Incidents.createTeam has a new signature
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from fbe54909cf8414a9e376dab0868968fdceefeaa0. SDK Automation 14.0.0
      command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
      warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
      command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    • ️✔️Azure.ResourceManager.SecurityInsights [View full logs]  [Preview SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from fbe54909cf8414a9e376dab0868968fdceefeaa0. 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]  notice
      cmderr	[automation_generate.sh] npm notice New major version of npm available! 8.19.2 -> 9.1.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.1.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.1.1` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-securityinsight [View full logs]  [Preview SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation group GetOperations
      info	[Changelog]   - Added operation group GetRecommendationsOperations
      info	[Changelog]   - Added operation group UpdateOperations
      info	[Changelog]   - Model AlertDetailsOverride has a new parameter alert_dynamic_properties
      info	[Changelog]   - Model NrtAlertRule has a new parameter sentinel_entities_mappings
      info	[Changelog]   - Model NrtAlertRuleTemplate has a new parameter sentinel_entities_mappings
      info	[Changelog]   - Model NrtAlertRuleTemplateProperties has a new parameter sentinel_entities_mappings
      info	[Changelog]   - Model QueryBasedAlertRuleTemplateProperties has a new parameter sentinel_entities_mappings
      info	[Changelog]   - Model ScheduledAlertRule has a new parameter sentinel_entities_mappings
      info	[Changelog]   - Model ScheduledAlertRuleCommonProperties has a new parameter sentinel_entities_mappings
      info	[Changelog]   - Model ScheduledAlertRuleProperties has a new parameter sentinel_entities_mappings
      info	[Changelog]   - Model ScheduledAlertRuleTemplate has a new parameter sentinel_entities_mappings
      info	[Changelog]   - Model SecurityAlertTimelineItem has a new parameter intent
      info	[Changelog]   - Model SecurityAlertTimelineItem has a new parameter techniques
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from fbe54909cf8414a9e376dab0868968fdceefeaa0. 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]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation group Get
      info	[Changelog]   - Added operation group GetRecommendations
      info	[Changelog]   - Added operation group Update
      info	[Changelog]   - Added Interface AlertPropertyMapping
      info	[Changelog]   - Added Interface Content
      info	[Changelog]   - Added Interface GetRecommendationsListOptionalParams
      info	[Changelog]   - Added Interface GetSingleRecommendationOptionalParams
      info	[Changelog]   - Added Interface Instructions
      info	[Changelog]   - Added Interface Recommendation
      info	[Changelog]   - Added Interface RecommendationList
      info	[Changelog]   - Added Interface RecommendationPatch
      info	[Changelog]   - Added Interface RecommendedAction
      info	[Changelog]   - Added Interface SentinelEntityMapping
      info	[Changelog]   - Added Interface UpdateRecommendationOptionalParams
      info	[Changelog]   - Added Type Alias AlertProperty
      info	[Changelog]   - Added Type Alias Category
      info	[Changelog]   - Added Type Alias Context
      info	[Changelog]   - Added Type Alias GetRecommendationsListResponse
      info	[Changelog]   - Added Type Alias GetSingleRecommendationResponse
      info	[Changelog]   - Added Type Alias Priority
      info	[Changelog]   - Added Type Alias State
      info	[Changelog]   - Added Type Alias UpdateRecommendationResponse
      info	[Changelog]   - Interface AlertDetailsOverride has a new optional parameter alertDynamicProperties
      info	[Changelog]   - Interface NrtAlertRule has a new optional parameter sentinelEntitiesMappings
      info	[Changelog]   - Interface NrtAlertRuleTemplate has a new optional parameter sentinelEntitiesMappings
      info	[Changelog]   - Interface QueryBasedAlertRuleTemplateProperties has a new optional parameter sentinelEntitiesMappings
      info	[Changelog]   - Interface ScheduledAlertRule has a new optional parameter sentinelEntitiesMappings
      info	[Changelog]   - Interface ScheduledAlertRuleCommonProperties has a new optional parameter sentinelEntitiesMappings
      info	[Changelog]   - Interface ScheduledAlertRuleTemplate has a new optional parameter sentinelEntitiesMappings
      info	[Changelog]   - Interface SecurityAlertTimelineItem has a new optional parameter intent
      info	[Changelog]   - Interface SecurityAlertTimelineItem has a new optional parameter techniques
      info	[Changelog]   - Class SecurityInsights has a new parameter get
      info	[Changelog]   - Class SecurityInsights has a new parameter getRecommendations
      info	[Changelog]   - Class SecurityInsights has a new parameter update
      info	[Changelog]   - Added Enum KnownAlertProperty
      info	[Changelog]   - Added Enum KnownCategory
      info	[Changelog]   - Added Enum KnownContext
      info	[Changelog]   - Added Enum KnownPriority
      info	[Changelog]   - Added Enum KnownState
      info	[Changelog]
      info	[Changelog] **Breaking Changes**
      info	[Changelog]
      info	[Changelog]   - Operation Incidents.createTeam has a new signature
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from fbe54909cf8414a9e376dab0868968fdceefeaa0. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      cmderr	[init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️❌ azure-resource-manager-schemas failed [Detail]
    • Failed [Logs] Generate from fbe54909cf8414a9e376dab0868968fdceefeaa0. 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] Generate from fbe54909cf8414a9e376dab0868968fdceefeaa0. 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]  [Preview SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Nov 10, 2022

    Generated ApiView

    Language Package Name ApiView Link
    Python track2_azure-mgmt-securityinsight Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    JavaScript @azure/arm-securityinsight Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    .Net Azure.ResourceManager.SecurityInsights Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

    @AzureRestAPISpecReview AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Nov 10, 2022
    @openapi-workflow-bot
    Copy link

    Hi @ityankel, 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.

    @ityankel ityankel marked this pull request as ready for review November 10, 2022 14:08
    @ityankel
    Copy link
    Contributor Author

    @dw511214992 , please note that this PR doesn't contain any changes in the routes or models of the incidents API. All the changes here are due to a technical change in how the swagger file is created (automatic generation instead of writing it manually) which reordered some properties in the various models.
    This is done as a first step to greatly reduce the number of changes in the next PR I will create for this new API version that will be adding a new nested resource so the new PR will only contain relevant changes.

    I took a look at the few failed validations and, at least as far as I can tell, the failures are false positives due to this reordering or some internal failures in the validation tools

    @ityankel
    Copy link
    Contributor Author

    I couldn't get this PR reviewed and merged in time to leave enough time for an ARM review for the follow-up PR before EOM, so closing this PR and releasing a PR with the full changes in !21542

    @ityankel ityankel closed this Nov 17, 2022
    @ityankel ityankel deleted the feature/ityankel/generatedIncidentsSwagger branch March 3, 2024 12:21
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-BreakingChange-JavaScript resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants