Fix SecurityInsights Swagger breaking-change compatibility regressions#43548
Fix SecurityInsights Swagger breaking-change compatibility regressions#43548AdiMegid wants to merge 39 commits into
Conversation
Next Steps to MergeNext steps that must be taken to merge this PR:
Comment generated by summarize-checks workflow run. |
API Change CheckAPIView identified API level changes in this PR and created the following API reviews
Comment generated by After APIView workflow run. |
There was a problem hiding this comment.
There are many cases like this. Please check.
There was a problem hiding this comment.
@pshao25
Same pattern three distinct ProvisioningState enums in the old swagger with different value sets:
- Watchlist.provisioningState - x-ms-enum.name: "ProvisioningState" with values New, InProgress, Uploading, Deleting, Succeeded, Failed, Canceled - defined in Watchlists.json (stable + preview)
- TriggeredAnalyticsRuleRun.provisioningState - x-ms-enum.name: "ProvisioningState" with values Accepted, InProgress, Succeeded, Failed, Canceled - defined in TriggeredAnalyticsRuleRuns.json (preview-only)
- WorkspaceManagerAssignment.lastJobProvisioningState - x-ms-enum.name: "provisioningState" with values Succeeded, InProgress, Canceled, Failed - defined inline in WorkspaceManagerAssignments.json (preview-only) - (change to JobProvisioningState)
…odels - Move required fields from PackageBaseProperties to PackageProperties and ProductPackageProperties - Move required fields from TemplateBaseProperties to TemplateProperties and ProductTemplateProperties - Restore ScheduledAlertRuleCommonProperties fields as required (no @madeOptional) - Remove unused stable/2025-09-01/common folder
…, WatchlistProvisioningState, JobProvisioningState)
There was a problem hiding this comment.
the incident task list is not supporting all requirement that Azure.Core.Page has, for example it marks the "value" as required whereas it wasn't like that in the previous version
There was a problem hiding this comment.
Why do we add finalresult to a delete operation?
There was a problem hiding this comment.
This is an async operation same as we have with createOrReplace few lines above
We did the change because the RetryAfterHeaders is not supported in the BE for this operation
|
/azp run |
|
You have several pipelines (over 10) configured to build pull requests in this repository. Specify which pipelines you would like to run by using /azp run [pipelines] command. You can specify multiple pipelines using a comma separated list. |
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
Swagger BreakingChange - Analyze Codejob for Microsoft.SecurityInsights by restoring schema compatibility in the generated ARM OpenAPI forstable/2025-09-01andpreview/2025-10-01-preview.Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
This PR updates the SecurityInsights TypeSpec source and regenerated OpenAPI to remove breaking-change regressions introduced by the generated swagger shape.
Implemented fixes include:
DataConnectorDefinitionArmCollectionWrappercompatibility sovalueis no longer newly requiredAvailabilityStatusschema reference for connector availabilityInstructionStepDetails.parametersan explicit object againOperation.displayto match the previous stable contractValidation performed:
npm exec -- tsp compile specification/securityinsights/resource-manager/Microsoft.SecurityInsights/SecurityInsights/main.tspnpm exec --no -- openapi-diff-runner ...witherrorCnt: 0andoadViolationsCnt: 0Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.
Getting help
Purpose of this PRandDue diligence checklist.write accessper aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositoriesNext Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.