Fixed Swagger correctness for SourceControls API #25976

oformaniuk · 2023-09-26T19:33:44Z

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

New API version. (Such PR should have been generated with OpenAPI Hub, per this wiki doc.)
Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
Update existing version to fix swagger quality issues in S360.
Other, please clarify:
- Fixed API correctness to match actual service API

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:

I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.

Breaking changes review (Step 1)

If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:
- The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
- You believe there is no need for you to request breaking change approval, for any reason.
  Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

If this PR is in purview of ARM review then automation will add the ARMReview label.
If you want to force ARM review, add the label yourself.
Proceed according to the diagram at the top of this comment.

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment 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
Swagger-Suppression-Process
to get approval.

Getting help

For general PR approval workflow, see the diagram at the top of this comment.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

openapi-pipeline-app · 2023-09-26T19:33:48Z

Next Steps to Merge

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

openapi-pipeline-app · 2023-09-26T19:33:49Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️⚠️Breaking Change(Cross-Version): 16 Warnings warning [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
SourceControls.json	2023-10-01-preview(892f9e3)	2023-09-01-preview(main)

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

Rule	Message
⚠️ 1009 - RemovedRequiredParameter	The required parameter 'repoType' was removed in the new version. Old: Microsoft.SecurityInsights/preview/2023-09-01-preview/SourceControls.json#L49:9
⚠️ 1010 - AddingRequiredParameter	The required parameter 'repositoryAccess' was added in the new version. New: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L49:9
⚠️ 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L239:9 Old: Microsoft.SecurityInsights/preview/2023-09-01-preview/SourceControls.json#L239:9
⚠️ 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L998:7 Old: Microsoft.SecurityInsights/preview/2023-09-01-preview/SourceControls.json#L958:7
⚠️ 1025 - RequiredStatusChange	The 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L358:7 Old: Microsoft.SecurityInsights/preview/2023-09-01-preview/SourceControls.json#L350:7
⚠️ 1025 - RequiredStatusChange	The 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L185:9 Old: Microsoft.SecurityInsights/preview/2023-09-01-preview/SourceControls.json#L185:9
⚠️ 1029 - ReadonlyPropertyChanged	The read only property has changed from 'true' to 'false'. New: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L404:9 Old: Microsoft.SecurityInsights/preview/2023-09-01-preview/SourceControls.json#L396:9
⚠️ 1029 - ReadonlyPropertyChanged	The read only property has changed from 'true' to 'false'. New: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L528:5 Old: Microsoft.SecurityInsights/preview/2023-09-01-preview/SourceControls.json#L492:5
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'repositoryAccess' renamed or removed? Old: Microsoft.SecurityInsights/preview/2023-09-01-preview/SourceControls.json#L239:9
⚠️ 1034 - AddedRequiredProperty	The new version has new required property 'properties' that was not found in the old version. New: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L337:11 Old: Microsoft.SecurityInsights/preview/2023-09-01-preview/SourceControls.json#L332:11
⚠️ 1034 - AddedRequiredProperty	The new version has new required property 'properties' that was not found in the old version. New: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L162:13 Old: Microsoft.SecurityInsights/preview/2023-09-01-preview/SourceControls.json#L162:13
⚠️ 1034 - AddedRequiredProperty	The new version has new required property 'properties' that was not found in the old version. New: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L185:9
⚠️ 1034 - AddedRequiredProperty	The new version has new required property 'properties' that was not found in the old version. New: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L208:13 Old: Microsoft.SecurityInsights/preview/2023-09-01-preview/SourceControls.json#L208:13
⚠️ 1034 - AddedRequiredProperty	The new version has new required property 'properties' that was not found in the old version. New: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L214:13 Old: Microsoft.SecurityInsights/preview/2023-09-01-preview/SourceControls.json#L214:13
⚠️ 1034 - AddedRequiredProperty	The new version has new required property 'properties' that was not found in the old version. New: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L239:9
⚠️ 1034 - AddedRequiredProperty	The new version has new required property 'properties' that was not found in the old version. New: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L348:5 Old: Microsoft.SecurityInsights/preview/2023-09-01-preview/SourceControls.json#L343:5

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.1.6)	new version	base version
package-preview-2023-10	package-preview-2023-10(892f9e3)	package-preview-2023-10(release-release-Sentinel-securityinsights-Microsoft.SecurityInsights-2023-10-01-preview)

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ ListInOperationName	Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L38
⚠️ OperationIdNounConflictingModelNames	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/2023-10-01-preview/SourceControls.json#L48
⚠️ LatestVersionOfCommonTypesMustBeUsed	Use the latest version v5 of types.json. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L51
⚠️ LatestVersionOfCommonTypesMustBeUsed	Use the latest version v5 of types.json. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L54
⚠️ LatestVersionOfCommonTypesMustBeUsed	Use the latest version v5 of types.json. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L57
⚠️ LatestVersionOfCommonTypesMustBeUsed	Use the latest version v5 of types.json. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L99
⚠️ LatestVersionOfCommonTypesMustBeUsed	Use the latest version v5 of types.json. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L102
⚠️ LatestVersionOfCommonTypesMustBeUsed	Use the latest version v5 of types.json. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L105
⚠️ LatestVersionOfCommonTypesMustBeUsed	Use the latest version v5 of types.json. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L144
⚠️ LatestVersionOfCommonTypesMustBeUsed	Use the latest version v5 of types.json. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L147
⚠️ LatestVersionOfCommonTypesMustBeUsed	Use the latest version v5 of types.json. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L150
⚠️ LatestVersionOfCommonTypesMustBeUsed	Use the latest version v5 of types.json. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L187
⚠️ LatestVersionOfCommonTypesMustBeUsed	Use the latest version v5 of types.json. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L190
⚠️ LatestVersionOfCommonTypesMustBeUsed	Use the latest version v5 of types.json. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L193
⚠️ LatestVersionOfCommonTypesMustBeUsed	Use the latest version v5 of types.json. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L241
⚠️ LatestVersionOfCommonTypesMustBeUsed	Use the latest version v5 of types.json. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L244
⚠️ LatestVersionOfCommonTypesMustBeUsed	Use the latest version v5 of types.json. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L247
⚠️ AllProxyResourcesShouldHaveDelete	The resource SourceControl does not have a corresponding delete operation. Location: Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json#L348
⚠️ 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/preview/2023-10-01-preview/SourceControls.json#L595

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️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.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

️️✔️Automated merging requirements met succeeded [Detail] [Expand]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-09-26T19:33:50Z

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 - Approved - 1.0.0-beta.7

+	Enum KnownRepoType no longer has value DevOps
+	Interface MstiDataConnectorDataTypes no longer has parameter bingSafetyPhishingURL
+	Interface Repository no longer has parameter pathMapping
+	Operation Incidents.createTeam has a new signature
+	Operation SourceControlOperations.listRepositories has a new signature
+	Operation SourceControls.delete has a new signature
+	Parameter branch of interface Repository is now required
+	Parameter contentTypes of interface SourceControl is now required
+	Parameter displayName of interface SourceControl is now required
+	Parameter logicAppResourceId of interface PlaybookActionProperties is now required
+	Parameter repoType of interface SourceControl is now required
+	Parameter repository of interface SourceControl is now required
+	Parameter url of interface Repository is now required
+	Removed Enum KnownEntityKind
+	Removed Enum KnownEnum13
+	Removed Enum KnownThreatIntelligenceResourceKindEnum
+	Removed Enum KnownThreatIntelligenceSortingCriteriaEnum
+	Type of parameter additionalData of interface AccountEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface AzureResourceEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface CloudApplicationEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface DnsEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface EntityCommonProperties is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface EntityEdges is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface FileEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface FileHashEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface HostEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface HuntingBookmark is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface IoTDeviceEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface IpEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface MailClusterEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface MailMessageEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface MailboxEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface MalwareEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface NicEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface ProcessEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface RegistryKeyEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface RegistryValueEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface SecurityAlert is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface SecurityGroupEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface SubmissionMailEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface ThreatIntelligenceIndicatorModel is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter additionalData of interface UrlEntity is changed from {
        [propertyName: string]: Record;
    } to {
        [propertyName: string]: any;
    }
+	Type of parameter entityKind of interface ExpansionResultAggregation is changed from EntityKind to EntityKindEnum
+	Type of parameter entityKind of interface IncidentEntitiesResultsMetadata is changed from EntityKind to EntityKindEnum
+	Type of parameter kind of interface Entity is changed from EntityKind to EntityKindEnum
+	Type of parameter kind of interface EntityQueriesListOptionalParams is changed from Enum13 to Enum20
+	Type of parameter kind of interface MetadataModel is changed from Kind to string
+	Type of parameter kind of interface MetadataPatch is changed from Kind to string
+	Type of parameter kind of interface ThreatIntelligenceInformation is changed from ThreatIntelligenceResourceKindEnum to ThreatIntelligenceResourceInnerKind
+	Type of parameter sortOrder of interface ThreatIntelligenceSortingCriteria is changed from ThreatIntelligenceSortingCriteriaEnum to ThreatIntelligenceSortingOrder
+	Type of parameter webhookSecretUpdateTime of interface Webhook is changed from string to Date

⚠️azure-sdk-for-python-track2 - track2_azure-mgmt-securityinsight - Approved - 2.0.0b2

+	Model MSTIDataConnectorDataTypes no longer has parameter bing_safety_phishing_url
+	Model Repository no longer has parameter path_mapping
+	Operation SourceControlOperations.list_repositories has a new required parameter repository_access
+	Operation SourceControlOperations.list_repositories no longer has parameter repo_type
+	Operation SourceControlsOperations.delete has a new required parameter repository_access
+	Parameter branch of model Repository is now required
+	Parameter content_types of model SourceControl is now required
+	Parameter display_name of model SourceControl is now required
+	Parameter logic_app_resource_id of model PlaybookActionProperties is now required
+	Parameter repo_type of model SourceControl is now required
+	Parameter repository of model SourceControl is now required
+	Parameter url of model Repository is now required

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from 396f7c74457fc547b2904547d64ab7e5233ab531. 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
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]
- Azure.ResourceManager.SecurityInsights.1.1.0-alpha.20231009.1.nupkg
```
info	[Changelog]
```

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs] Generate from 396f7c74457fc547b2904547d64ab7e5233ab531. 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! 9.8.1 -> 10.2.0
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.0>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.2.0` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-securityinsight [View full logs] [Preview SDK Changes] Breaking Change Detected

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Added operation EntitiesOperations.run_playbook
info	[Changelog]   - Added operation group AlertRuleOperations
info	[Changelog]   - Added operation group BillingStatisticsOperations
info	[Changelog]   - Added operation group ContentPackageOperations
info	[Changelog]   - Added operation group ContentPackagesOperations
info	[Changelog]   - Added operation group ContentTemplateOperations
info	[Changelog]   - Added operation group ContentTemplatesOperations
info	[Changelog]   - Added operation group DataConnectorDefinitionsOperations
info	[Changelog]   - Added operation group GetTriggeredAnalyticsRuleRunsOperations
info	[Changelog]   - Added operation group HuntCommentsOperations
info	[Changelog]   - Added operation group HuntRelationsOperations
info	[Changelog]   - Added operation group HuntsOperations
info	[Changelog]   - Added operation group ProductPackageOperations
info	[Changelog]   - Added operation group ProductPackagesOperations
info	[Changelog]   - Added operation group ProductTemplateOperations
info	[Changelog]   - Added operation group ProductTemplatesOperations
info	[Changelog]   - Added operation group TriggeredAnalyticsRuleRunOperations
info	[Changelog]   - Added operation group WorkspaceManagerAssignmentJobsOperations
info	[Changelog]   - Added operation group WorkspaceManagerAssignmentsOperations
info	[Changelog]   - Added operation group WorkspaceManagerConfigurationsOperations
info	[Changelog]   - Added operation group WorkspaceManagerGroupsOperations
info	[Changelog]   - Added operation group WorkspaceManagerMembersOperations
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
info	[Changelog]   - Model Repo has a new parameter installation_id
info	[Changelog]   - Model SourceControl has a new parameter pull_request
info	[Changelog]   - Model SourceControl has a new parameter repository_access
info	[Changelog]   - Model SourceControl has a new parameter service_principal
info	[Changelog]
info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog]   - Model MSTIDataConnectorDataTypes no longer has parameter bing_safety_phishing_url
info	[Changelog]   - Model Repository no longer has parameter path_mapping
info	[Changelog]   - Operation SourceControlOperations.list_repositories has a new required parameter repository_access
info	[Changelog]   - Operation SourceControlOperations.list_repositories no longer has parameter repo_type
info	[Changelog]   - Operation SourceControlsOperations.delete has a new required parameter repository_access
info	[Changelog]   - Parameter branch of model Repository is now required
info	[Changelog]   - Parameter content_types of model SourceControl is now required
info	[Changelog]   - Parameter display_name of model SourceControl is now required
info	[Changelog]   - Parameter logic_app_resource_id of model PlaybookActionProperties is now required
info	[Changelog]   - Parameter repo_type of model SourceControl is now required
info	[Changelog]   - Parameter repository of model SourceControl is now required
info	[Changelog]   - Parameter url of model Repository is now required

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from 396f7c74457fc547b2904547d64ab7e5233ab531. 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

azure-arm-securityinsight-1.0.0-beta.7.tgz

Only show 120 items here, please refer to log for details.

info	[Changelog]     }
info	[Changelog]   - Type of parameter kind of interface Entity is changed from EntityKind to EntityKindEnum
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 Enum20
info	[Changelog]   - Type of parameter entityKind of interface ExpansionResultAggregation is changed from EntityKind to EntityKindEnum
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 entityKind of interface IncidentEntitiesResultsMetadata is changed from EntityKind to EntityKindEnum
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 kind of interface MetadataModel is changed from Kind to string
info	[Changelog]   - Type of parameter kind of interface MetadataPatch is changed from Kind to string
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 kind of interface ThreatIntelligenceInformation is changed from ThreatIntelligenceResourceKindEnum to ThreatIntelligenceResourceInnerKind
info	[Changelog]   - Type of parameter sortOrder of interface ThreatIntelligenceSortingCriteria is changed from ThreatIntelligenceSortingCriteriaEnum to ThreatIntelligenceSortingOrder
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]   - Type of parameter webhookSecretUpdateTime of interface Webhook is changed from string to Date
info	[Changelog]   - Removed Enum KnownEntityKind
info	[Changelog]   - Removed Enum KnownEnum13
info	[Changelog]   - Removed Enum KnownThreatIntelligenceResourceKindEnum
info	[Changelog]   - Removed Enum KnownThreatIntelligenceSortingCriteriaEnum
info	[Changelog]   - Enum KnownRepoType no longer has value DevOps

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs] Generate from 396f7c74457fc547b2904547d64ab7e5233ab531. 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 is available: 23.0.1 -> 23.2.1
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.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

️✔️azure-resourcemanager-securityinsights [View full logs] [Preview SDK Changes]

️❌ azure-resource-manager-schemas failed [Detail]

❌Failed [Logs] Generate from 396f7c74457fc547b2904547d64ab7e5233ab531. 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] npm notice
cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.2.0
cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.0>
cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.2.0` to update!
cmderr	[initScript.sh] npm notice
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]

❌Pipeline Framework Failed [Logs] Generate from 396f7c74457fc547b2904547d64ab7e5233ab531. 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
SSL error: syscall failure: Broken pipe
Error: SSL error: syscall failure: Broken pipe

⚠️Az.securityinsights.DefaultTag [View full logs]

error	Fatal error: SSL error: syscall failure: Broken pipe
error	The following packages are still pending:
error		Az.securityinsights.DefaultTag

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-09-26T19:33:51Z

Generated ApiView

Language	Package Name	ApiView Link
Java	azure-resourcemanager-securityinsights	https://apiview.dev/Assemblies/Review/bc86630d92a246b296f2ba37a611498f
.Net	Azure.ResourceManager.SecurityInsights	There is no API change compared with the previous version
JavaScript	@azure/arm-securityinsight	https://apiview.dev/Assemblies/Review/94d9599d1b284cb799a639c0ffd4c49f
Swagger	Microsoft.SecurityInsights	https://apiview.dev/Assemblies/Review/76777b6778f84b67bcee344da49abc92

oformaniuk · 2023-09-27T21:09:47Z

/pr RequestMerge

...s/resource-manager/Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json

openapi-workflow-bot · 2023-09-28T02:36:58Z

Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

oformaniuk · 2023-10-04T22:11:50Z

/az run

oformaniuk · 2023-10-04T22:53:04Z

/azp run

azure-pipelines · 2023-10-04T22:53:17Z

Azure Pipelines successfully started running 2 pipeline(s).

oformaniuk · 2023-10-26T17:29:49Z

/pr RequestMerge

Fixed Swagger correctness for SourceControls API

6fc27f3

openapi-assignment-bot bot assigned rkmanda Sep 26, 2023

AzureRestAPISpecReview added ARMReview resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 26, 2023

azure-sdk mentioned this pull request Sep 26, 2023

[AutoPR @azure/arm-securityinsight] Fixed Swagger correctness for SourceControls API azure-sdk/azure-sdk-for-js#6866

Closed

openapi-pipeline-app bot added the CI-BreakingChange-JavaScript label Sep 26, 2023

openapi-pipeline-app bot added the CI-BreakingChange-Python-Track2 label Sep 26, 2023

azure-sdk mentioned this pull request Sep 26, 2023

[AutoPR azure-resourcemanager-securityinsights] Fixed Swagger correctness for SourceControls API azure-sdk/azure-sdk-for-java#7166

Closed

Fix a typo

4b64f7c

github-actions bot added the MergeRequested label Sep 27, 2023

raosuhas reviewed Sep 28, 2023

View reviewed changes

...s/resource-manager/Microsoft.SecurityInsights/preview/2023-10-01-preview/SourceControls.json Show resolved Hide resolved

raosuhas added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Sep 28, 2023

openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 28, 2023

raosuhas removed the MergeRequested label Sep 28, 2023

Oleh Formaniuk added 2 commits October 6, 2023 13:00

Fix CI errors

387f682

Fixed styling

892f9e3

xuhumsft added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels Oct 24, 2023

ms-henglu added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Oct 25, 2023

openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 25, 2023

kazrael2119 added the Approved-SdkBreakingChange-JavaScript label Oct 25, 2023

msyyc added the Approved-SdkBreakingChange-Python label Oct 26, 2023

github-actions bot added the MergeRequested label Oct 26, 2023

ms-henglu approved these changes Oct 27, 2023

View reviewed changes

ms-henglu merged commit 3ed5da4 into Azure:release-release-Sentinel-securityinsights-Microsoft.SecurityInsights-2023-10-01-preview Oct 27, 2023
24 of 27 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixed Swagger correctness for SourceControls API #25976

Fixed Swagger correctness for SourceControls API #25976

oformaniuk commented Sep 26, 2023

openapi-pipeline-app bot commented Sep 26, 2023 •

edited

Loading

openapi-pipeline-app bot commented Sep 26, 2023 •

edited

Loading

openapi-pipeline-app bot commented Sep 26, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Sep 26, 2023 •

edited

Loading

oformaniuk commented Sep 27, 2023

openapi-workflow-bot bot commented Sep 28, 2023

oformaniuk commented Oct 4, 2023

oformaniuk commented Oct 4, 2023

azure-pipelines bot commented Oct 4, 2023

oformaniuk commented Oct 26, 2023

Fixed Swagger correctness for SourceControls API #25976

Fixed Swagger correctness for SourceControls API #25976

Conversation

oformaniuk commented Sep 26, 2023

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Breaking changes review (Step 1)

ARM API changes review (Step 2)

Viewing API changes

Suppressing failures

Getting help

openapi-pipeline-app bot commented Sep 26, 2023 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Sep 26, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Sep 26, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Sep 26, 2023 • edited Loading

Generated ApiView

oformaniuk commented Sep 27, 2023

openapi-workflow-bot bot commented Sep 28, 2023

oformaniuk commented Oct 4, 2023

oformaniuk commented Oct 4, 2023

azure-pipelines bot commented Oct 4, 2023

oformaniuk commented Oct 26, 2023

openapi-pipeline-app bot commented Sep 26, 2023 •

edited

Loading

openapi-pipeline-app bot commented Sep 26, 2023 •

edited

Loading

openapi-pipeline-app bot commented Sep 26, 2023 •

edited

Loading

openapi-pipeline-app bot commented Sep 26, 2023 •

edited

Loading