Swagger Correctness #22120

sparatala · 2023-01-10T06:36:18Z

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:

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
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.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
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):

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

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 · 2023-01-10T06:36:21Z

Hi, @sparatala 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 · 2023-01-10T06:36:22Z

Swagger Validation Report

️❌BreakingChange: 9 Errors, 0 Warnings failed [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
types.json	v1(3fe6388)	v1(main)
bigDataPool.json	2021-06-01-preview(3fe6388)	2021-06-01-preview(main)
integrationRuntime.json	2021-06-01-preview(3fe6388)	2021-06-01-preview(main)
workspace.json	2021-06-01-preview(3fe6388)	2021-06-01-preview(main)
bigDataPool.json	2021-06-01(3fe6388)	2021-06-01(main)
sqlPool.json	2021-06-01(3fe6388)	2021-06-01(main)
workspace.json	2021-06-01(3fe6388)	2021-06-01(main)

Rule	Message
`❌` 1011 - AddingResponseCode	The new version adds a response code '201'. New: Microsoft.Synapse/stable/2021-06-01/sqlPool.json#L702:11
`❌` 1022 - RemovedAdditionalProperties	The new version removes the 'additionalProperties' element. New: Microsoft.Synapse/preview/2021-06-01-preview/workspace.json#L1458:9 Old: Microsoft.Synapse/preview/2021-06-01-preview/workspace.json#L1446:9
`❌` 1022 - RemovedAdditionalProperties	The new version removes the 'additionalProperties' element. New: Microsoft.Synapse/stable/2021-06-01/workspace.json#L1296:9 Old: Microsoft.Synapse/stable/2021-06-01/workspace.json#L1291:9
`❌` 1029 - ReadonlyPropertyChanged	The read only property has changed from 'false' to 'true'. New: synapse/common/v1/types.json#L254:9 Old: synapse/common/v1/types.json#L254:9
`❌` 1029 - ReadonlyPropertyChanged	The read only property has changed from 'false' to 'true'. New: synapse/common/v1/types.json#L254:9 Old: synapse/common/v1/types.json#L254:9
`❌` 1029 - ReadonlyPropertyChanged	The read only property has changed from 'false' to 'true'. New: synapse/common/v1/types.json#L254:9 Old: synapse/common/v1/types.json#L254:9
`❌` 1029 - ReadonlyPropertyChanged	The read only property has changed from 'false' to 'true'. New: Microsoft.Synapse/stable/2021-06-01/workspace.json#L1267:9 Old: Microsoft.Synapse/stable/2021-06-01/workspace.json#L1259:9
`❌` 1045 - AddedOptionalProperty	The new version has a new optional property 'osType' that was not found in the old version. New: Microsoft.Synapse/preview/2021-06-01-preview/integrationRuntime.json#L2341:7 Old: Microsoft.Synapse/preview/2021-06-01-preview/integrationRuntime.json#L2341:7
`❌` 1045 - AddedOptionalProperty	The new version has a new optional property 'targetFramework' that was not found in the old version. New: Microsoft.Synapse/preview/2021-06-01-preview/integrationRuntime.json#L2341:7 Old: Microsoft.Synapse/preview/2021-06-01-preview/integrationRuntime.json#L2341:7

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️🔄LintDiff inProgress [Detail]

️⚠️Avocado: 1 Warnings warning [Detail]

Rule	Message
⚠️ MULTIPLE_API_VERSION	The default tag contains multiple API versions swaggers. readme: specification/synapse/resource-manager/readme.md tag: specification/synapse/resource-manager/readme.md#tag-package-composite-v2

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️❌~[Staging] SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]

️️✔️~[Staging] CadlAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️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 · 2023-01-10T06:36:24Z

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-go - sdk/resourcemanager/synapse/armsynapse - 0.6.0

+	Field `Interface` of struct `BigDataPoolsClientDeleteResponse` has been removed
+	Field `Interface` of struct `IPFirewallRulesClientDeleteResponse` has been removed
+	Field `Interface` of struct `SQLPoolsClientDeleteResponse` has been removed
+	Field `Interface` of struct `SQLPoolsClientPauseResponse` has been removed
+	Field `Interface` of struct `SQLPoolsClientResumeResponse` has been removed
+	Field `Interface` of struct `WorkspacesClientDeleteResponse` has been removed
+	Operation `*SQLPoolOperationResultsClient.GetLocationHeaderResult` has been changed to LRO, use `*SQLPoolOperationResultsClient.BeginGetLocationHeaderResult` instead.
+	Operation `*SQLPoolsClient.Update` has been changed to LRO, use `*SQLPoolsClient.BeginUpdate` instead.
+	Type alias `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityActualState` has been removed
+	Type alias `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityDesiredState` has been removed
+	Type of `CmdkeySetupTypeProperties.TargetName` has been changed from `interface{}` to `any`
+	Type of `CmdkeySetupTypeProperties.UserName` has been changed from `interface{}` to `any`
+	Type of `ErrorAdditionalInfo.Info` has been changed from `interface{}` to `any`
+	Type of `IntegrationRuntime.AdditionalProperties` has been changed from `map[string]interface{}` to `map[string]any`
+	Type of `IntegrationRuntimeComputeProperties.AdditionalProperties` has been changed from `map[string]interface{}` to `map[string]any`
+	Type of `IntegrationRuntimeConnectionInfo.AdditionalProperties` has been changed from `map[string]interface{}` to `map[string]any`
+	Type of `IntegrationRuntimeDataFlowProperties.AdditionalProperties` has been changed from `map[string]interface{}` to `map[string]any`
+	Type of `IntegrationRuntimeNodeMonitoringData.AdditionalProperties` has been changed from `map[string]interface{}` to `map[string]any`
+	Type of `IntegrationRuntimeSsisCatalogInfo.AdditionalProperties` has been changed from `map[string]interface{}` to `map[string]any`
+	Type of `IntegrationRuntimeSsisProperties.AdditionalProperties` has been changed from `map[string]interface{}` to `map[string]any`
+	Type of `IntegrationRuntimeStatus.AdditionalProperties` has been changed from `map[string]interface{}` to `map[string]any`
+	Type of `IntegrationRuntimeVNetProperties.AdditionalProperties` has been changed from `map[string]interface{}` to `map[string]any`
+	Type of `KekIdentityProperties.UseSystemAssignedIdentity` has been changed from `interface{}` to `any`
+	Type of `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentity.ActualState` has been changed from `*ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityActualState` to `*ActualState`
+	Type of `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentity.DesiredState` has been changed from `*ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityDesiredState` to `*DesiredState`
+	Type of `ManagedIntegrationRuntime.AdditionalProperties` has been changed from `map[string]interface{}` to `map[string]any`
+	Type of `ManagedIntegrationRuntimeError.AdditionalProperties` has been changed from `map[string]interface{}` to `map[string]any`
+	Type of `ManagedIntegrationRuntimeNode.AdditionalProperties` has been changed from `map[string]interface{}` to `map[string]any`
+	Type of `ManagedIntegrationRuntimeOperationResult.AdditionalProperties` has been changed from `map[string]interface{}` to `map[string]any`
+	Type of `ManagedIntegrationRuntimeStatus.AdditionalProperties` has been changed from `map[string]interface{}` to `map[string]any`
+	Type of `Operation.Properties` has been changed from `interface{}` to `any`
+	Type of `OperationResource.Properties` has been changed from `interface{}` to `any`
+	Type of `SKUDescription.Restrictions` has been changed from `[]interface{}` to `[]any`
+	Type of `SelfHostedIntegrationRuntime.AdditionalProperties` has been changed from `map[string]interface{}` to `map[string]any`
+	Type of `SelfHostedIntegrationRuntimeNode.AdditionalProperties` has been changed from `map[string]interface{}` to `map[string]any`
+	Type of `SelfHostedIntegrationRuntimeStatus.AdditionalProperties` has been changed from `map[string]interface{}` to `map[string]any`
+	Type of `ServerVulnerabilityAssessmentProperties.RecurringScans` has been changed from `*VulnerabilityAssessmentRecurringScansProperties` to `*VulnerabilityAssessmentRecurringScansPropertiesAutoGenerated`
+	Type of `WorkspaceProperties.ExtraProperties` has been changed from `map[string]interface{}` to `any`
+	Type of `WorkspaceProperties.Settings` has been changed from `map[string]interface{}` to `map[string]any`

❌azure-sdk-for-js - @azure/arm-synapse - 9.0.0-beta.1

+	Class SynapseManagementClient no longer has parameter privateLinkResources
+	Interface IntegrationRuntimeStatusResponse has a new required parameter type
+	Interface IntegrationRuntimeStatusResponse no longer has parameter properties
+	Interface SqlPoolSchemasListNextOptionalParams no longer has parameter filter
+	Interface SqlPoolSensitivityLabelsListCurrentNextOptionalParams no longer has parameter filter
+	Interface SqlPoolSensitivityLabelsListRecommendedNextOptionalParams no longer has parameter filter
+	Interface SqlPoolSensitivityLabelsListRecommendedNextOptionalParams no longer has parameter includeDisabledRecommendations
+	Interface SqlPoolSensitivityLabelsListRecommendedNextOptionalParams no longer has parameter skipToken
+	Interface SqlPoolTableColumnsListByTableNameNextOptionalParams no longer has parameter filter
+	Interface SqlPoolTablesListBySchemaNextOptionalParams no longer has parameter filter
+	Removed Enum KnownManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentityActualState
+	Removed Enum KnownManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentityDesiredState
+	Removed operation SqlPoolOperationResults.getLocationHeaderResult
+	Removed operation SqlPools.update
+	Removed operation group PrivateLinkResources
+	Type of parameter actualState of interface ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity is changed from ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentityActualState to ActualState
+	Type of parameter desiredState of interface ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity is changed from ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentityDesiredState to DesiredState

️❌ azure-sdk-for-net-track2 failed [Detail]

❌Pipeline Framework Failed [Logs]Release - Generate from b9e0cdd. 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
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:836
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 836 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to build sdk. exit code: False
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
cannot force update branch 'sdkAuto/Azure.ResourceManager.Synapse' as it is the current HEAD of the repository.
Error: cannot force update branch 'sdkAuto/Azure.ResourceManager.Synapse' as it is the current HEAD of the repository.

️✔️Azure.ResourceManager.Synapse [View full logs] [Release SDK Changes]
- Azure.ResourceManager.Synapse.1.2.0-alpha.20230201.1.nupkg
```
info	[Changelog]
```

❌Azure.ResourceManager.Synapse [View full logs] Breaking Change Detected

error	Fatal error: cannot force update branch 'sdkAuto/Azure.ResourceManager.Synapse' as it is the current HEAD of the repository.
error	The following packages are still pending:
error		Azure.ResourceManager.Synapse
error		Azure.ResourceManager.Synapse

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

️✔️Succeeded [Logs]Release - Generate from b9e0cdd. 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-synapse [View full logs] [Release SDK Changes] Breaking Change Detected

azure-arm-synapse-9.0.0-beta.1.tgz

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

info	[Changelog]   - Added Interface ErrorResponseAutoGenerated
info	[Changelog]   - Added Interface EventGridDataConnection
info	[Changelog]   - Added Interface EventHubDataConnection
info	[Changelog]   - Added Interface ExtendedServerBlobAuditingPolicy
info	[Changelog]   - Added Interface ExtendedSqlPoolBlobAuditingPolicy
info	[Changelog]   - Added Interface GeoBackupPolicy
info	[Changelog]   - Added Interface GetIntegrationRuntimeEnableInteractivequeryOptionalParams
info	[Changelog]   - Added Interface GetIntegrationRuntimeStartOptionalParams
info	[Changelog]   - Added Interface GetIntegrationRuntimeStopOptionalParams
info	[Changelog]   - Added Interface IntegrationRuntimeEnableinteractivequery
info	[Changelog]   - Added Interface IntegrationRuntimeOperationStatus
info	[Changelog]   - Added Interface IntegrationRuntimeResource
info	[Changelog]   - Added Interface IntegrationRuntimeStopOperationStatus
info	[Changelog]   - Added Interface IotHubDataConnection
info	[Changelog]   - Added Interface IpFirewallRuleInfo
info	[Changelog]   - Added Interface Key
info	[Changelog]   - Added Interface KustoPool
info	[Changelog]   - Added Interface KustoPoolPrivateLinkResources
info	[Changelog]   - Added Interface KustoPoolPrivateLinkResourcesListOptionalParams
info	[Changelog]   - Added Interface KustoPoolUpdate
info	[Changelog]   - Added Interface LibraryResource
info	[Changelog]   - Added Interface LinkedIntegrationRuntimeKeyAuthorization
info	[Changelog]   - Added Interface LinkedIntegrationRuntimeRbacAuthorization
info	[Changelog]   - Added Interface MaintenanceWindowOptions
info	[Changelog]   - Added Interface MaintenanceWindows
info	[Changelog]   - Added Interface ManagedIdentitySqlControlSettingsModel
info	[Changelog]   - Added Interface ManagedIntegrationRuntime
info	[Changelog]   - Added Interface ManagedIntegrationRuntimeStatus
info	[Changelog]   - Added Interface MetadataSyncConfig
info	[Changelog]   - Added Interface PrivateEndpointConnection
info	[Changelog]   - Added Interface PrivateEndpointConnectionForPrivateLinkHub
info	[Changelog]   - Added Interface PrivateLinkHub
info	[Changelog]   - Added Interface PrivateLinkResource
info	[Changelog]   - Added Interface PrivateLinkResources
info	[Changelog]   - Added Interface ProxyResource
info	[Changelog]   - Added Interface ReadOnlyFollowingDatabase
info	[Changelog]   - Added Interface ReadWriteDatabase
info	[Changelog]   - Added Interface RecommendedSensitivityLabelUpdate
info	[Changelog]   - Added Interface RecoverableSqlPool
info	[Changelog]   - Added Interface ReplicationLink
info	[Changelog]   - Added Interface RestorableDroppedSqlPool
info	[Changelog]   - Added Interface RestorePoint
info	[Changelog]   - Added Interface SecureString
info	[Changelog]   - Added Interface SelfHostedIntegrationRuntime
info	[Changelog]   - Added Interface SelfHostedIntegrationRuntimeStatus
info	[Changelog]   - Added Interface SensitivityLabel
info	[Changelog]   - Added Interface SensitivityLabelUpdate
info	[Changelog]   - Added Interface ServerBlobAuditingPolicy
info	[Changelog]   - Added Interface ServerSecurityAlertPolicy
info	[Changelog]   - Added Interface ServerVulnerabilityAssessment
info	[Changelog]   - Added Interface SparkConfigurationResource
info	[Changelog]   - Added Interface SqlPool
info	[Changelog]   - Added Interface SqlPoolBlobAuditingPolicy
info	[Changelog]   - Added Interface SqlPoolColumn
info	[Changelog]   - Added Interface SqlPoolConnectionPolicy
info	[Changelog]   - Added Interface SqlPoolOperation
info	[Changelog]   - Added Interface SqlPoolSchema
info	[Changelog]   - Added Interface SqlPoolSecurityAlertPolicy
info	[Changelog]   - Added Interface SqlPoolTable
info	[Changelog]   - Added Interface SqlPoolVulnerabilityAssessment
info	[Changelog]   - Added Interface SqlPoolVulnerabilityAssessmentRuleBaseline
info	[Changelog]   - Added Interface SqlPoolVulnerabilityAssessmentScansExport
info	[Changelog]   - Added Interface SsisEnvironment
info	[Changelog]   - Added Interface SsisFolder
info	[Changelog]   - Added Interface SsisPackage
info	[Changelog]   - Added Interface SsisProject
info	[Changelog]   - Added Interface SubResource
info	[Changelog]   - Added Interface TrackedResource
info	[Changelog]   - Added Interface TransparentDataEncryption
info	[Changelog]   - Added Interface VulnerabilityAssessmentRecurringScansPropertiesAutoGenerated
info	[Changelog]   - Added Interface VulnerabilityAssessmentScanRecord
info	[Changelog]   - Added Interface WorkloadClassifier
info	[Changelog]   - Added Interface WorkloadGroup
info	[Changelog]   - Added Interface Workspace
info	[Changelog]   - Added Interface WorkspaceAadAdminInfo
info	[Changelog]   - Added Interface WorkspaceManagedSqlServerDedicatedSQLMinimalTlsSettingsGetOptionalParams
info	[Changelog]   - Added Interface WorkspaceManagedSqlServerDedicatedSQLMinimalTlsSettingsListNextOptionalParams
info	[Changelog]   - Added Interface WorkspaceManagedSqlServerDedicatedSQLMinimalTlsSettingsListOptionalParams
info	[Changelog]   - Added Interface WorkspaceManagedSqlServerDedicatedSQLMinimalTlsSettingsUpdateOptionalParams
info	[Changelog]   - Added Type Alias ActualState
info	[Changelog]   - Added Type Alias DedicatedSQLMinimalTlsSettingsName
info	[Changelog]   - Added Type Alias DesiredState
info	[Changelog]   - Added Type Alias GetIntegrationRuntimeEnableInteractivequeryResponse
info	[Changelog]   - Added Type Alias GetIntegrationRuntimeStartResponse
info	[Changelog]   - Added Type Alias GetIntegrationRuntimeStopResponse
info	[Changelog]   - Added Type Alias KustoPoolPrivateLinkResourcesListResponse
info	[Changelog]   - Added Type Alias WorkspaceManagedSqlServerDedicatedSQLMinimalTlsSettingsGetResponse
info	[Changelog]   - Added Type Alias WorkspaceManagedSqlServerDedicatedSQLMinimalTlsSettingsListNextResponse
info	[Changelog]   - Added Type Alias WorkspaceManagedSqlServerDedicatedSQLMinimalTlsSettingsListResponse
info	[Changelog]   - Added Type Alias WorkspaceManagedSqlServerDedicatedSQLMinimalTlsSettingsUpdateResponse
info	[Changelog]   - Added Type Alias WorkspaceStatus
info	[Changelog]   - Interface IntegrationRuntimeStatusResponse has a new optional parameter dataFactoryName
info	[Changelog]   - Interface IntegrationRuntimeStatusResponse has a new optional parameter state
info	[Changelog]   - Interface SqlPoolOperationResultsGetLocationHeaderResultOptionalParams has a new optional parameter resumeFrom
info	[Changelog]   - Interface SqlPoolOperationResultsGetLocationHeaderResultOptionalParams has a new optional parameter updateIntervalInMs
info	[Changelog]   - Interface SqlPoolsUpdateOptionalParams has a new optional parameter resumeFrom
info	[Changelog]   - Interface SqlPoolsUpdateOptionalParams has a new optional parameter updateIntervalInMs
info	[Changelog]   - Added Enum KnownDedicatedSQLMinimalTlsSettingsName
info	[Changelog]   - Added Enum KnownWorkspaceStatus
info	[Changelog]   - Added function getContinuationToken
info	[Changelog]
info	[Changelog] **Breaking Changes**
info	[Changelog]
info	[Changelog]   - Removed operation group PrivateLinkResources
info	[Changelog]   - Removed operation SqlPoolOperationResults.getLocationHeaderResult
info	[Changelog]   - Removed operation SqlPools.update
info	[Changelog]   - Interface IntegrationRuntimeStatusResponse no longer has parameter properties
info	[Changelog]   - Interface SqlPoolSchemasListNextOptionalParams no longer has parameter filter
info	[Changelog]   - Interface SqlPoolSensitivityLabelsListCurrentNextOptionalParams no longer has parameter filter
info	[Changelog]   - Interface SqlPoolSensitivityLabelsListRecommendedNextOptionalParams no longer has parameter filter
info	[Changelog]   - Interface SqlPoolSensitivityLabelsListRecommendedNextOptionalParams no longer has parameter includeDisabledRecommendations
info	[Changelog]   - Interface SqlPoolSensitivityLabelsListRecommendedNextOptionalParams no longer has parameter skipToken
info	[Changelog]   - Interface SqlPoolTableColumnsListByTableNameNextOptionalParams no longer has parameter filter
info	[Changelog]   - Interface SqlPoolTablesListBySchemaNextOptionalParams no longer has parameter filter
info	[Changelog]   - Interface IntegrationRuntimeStatusResponse has a new required parameter type
info	[Changelog]   - Type of parameter actualState of interface ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity is changed from ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentityActualState to ActualState
info	[Changelog]   - Type of parameter desiredState of interface ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentity is changed from ManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentityDesiredState to DesiredState
info	[Changelog]   - Class SynapseManagementClient no longer has parameter privateLinkResources
info	[Changelog]   - Removed Enum KnownManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentityActualState
info	[Changelog]   - Removed Enum KnownManagedIdentitySqlControlSettingsModelPropertiesGrantSqlControlToManagedIdentityDesiredState

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

⚠️Warning [Logs]Release - Generate from b9e0cdd. 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.1 -> 23.0
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip available: 22.3.1 -> 23.0
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-synapse [View full logs] [Release SDK Changes]

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

⚠️Warning [Logs]Release - Generate from b9e0cdd. 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]
cmderr	[automation_generate.sh] npm notice New major version of npm available! 8.19.3 -> 9.4.0
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.4.0>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.4.0` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-synapse [View full logs] [Release SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Added operation group GetOperations
info	[Changelog]   - Model SelfHostedIntegrationRuntimeStatus has a new parameter os_type
info	[Changelog]   - Model SelfHostedIntegrationRuntimeStatus has a new parameter target_framework

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

️✔️Succeeded [Logs]Release - Generate from b9e0cdd. SDK Automation 14.0.0

command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️sdk/resourcemanager/synapse/armsynapse [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Type of `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentity.DesiredState` has been changed from `*ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityDesiredState` to `*DesiredState`
info	[Changelog] - Type of `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentity.ActualState` has been changed from `*ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityActualState` to `*ActualState`
info	[Changelog] - Type of `ServerVulnerabilityAssessmentProperties.RecurringScans` has been changed from `*VulnerabilityAssessmentRecurringScansProperties` to `*VulnerabilityAssessmentRecurringScansPropertiesAutoGenerated`
info	[Changelog] - Type alias `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityActualState` has been removed
info	[Changelog] - Type alias `ManagedIdentitySQLControlSettingsModelPropertiesGrantSQLControlToManagedIdentityDesiredState` has been removed
info	[Changelog] - Operation `*SQLPoolOperationResultsClient.GetLocationHeaderResult` has been changed to LRO, use `*SQLPoolOperationResultsClient.BeginGetLocationHeaderResult` instead.
info	[Changelog] - Operation `*SQLPoolsClient.Update` has been changed to LRO, use `*SQLPoolsClient.BeginUpdate` instead.
info	[Changelog] - Field `Interface` of struct `BigDataPoolsClientDeleteResponse` has been removed
info	[Changelog] - Field `Interface` of struct `IPFirewallRulesClientDeleteResponse` has been removed
info	[Changelog] - Field `Interface` of struct `SQLPoolsClientDeleteResponse` has been removed
info	[Changelog] - Field `Interface` of struct `SQLPoolsClientPauseResponse` has been removed
info	[Changelog] - Field `Interface` of struct `SQLPoolsClientResumeResponse` has been removed
info	[Changelog] - Field `Interface` of struct `WorkspacesClientDeleteResponse` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New type alias `ActualState` with values `ActualStateDisabled`, `ActualStateDisabling`, `ActualStateEnabled`, `ActualStateEnabling`, `ActualStateUnknown`
info	[Changelog] - New type alias `DesiredState` with values `DesiredStateDisabled`, `DesiredStateEnabled`
info	[Changelog] - New type alias `WorkspaceStatus` with values `WorkspaceStatusFailed`, `WorkspaceStatusInProgress`, `WorkspaceStatusSucceeded`
info	[Changelog] - New function `NewGetClient(string, azcore.TokenCredential, *arm.ClientOptions) (*GetClient, error)`
info	[Changelog] - New function `*GetClient.IntegrationRuntimeEnableInteractivequery(context.Context, string, string, string, string, *GetClientIntegrationRuntimeEnableInteractivequeryOptions) (GetClientIntegrationRuntimeEnableInteractivequeryResponse, error)`
info	[Changelog] - New function `*GetClient.IntegrationRuntimeStart(context.Context, string, string, string, string, *GetClientIntegrationRuntimeStartOptions) (GetClientIntegrationRuntimeStartResponse, error)`
info	[Changelog] - New function `*GetClient.IntegrationRuntimeStop(context.Context, string, string, string, string, *GetClientIntegrationRuntimeStopOptions) (GetClientIntegrationRuntimeStopResponse, error)`
info	[Changelog] - New function `NewKustoPoolPrivateLinkResourcesClient(string, azcore.TokenCredential, *arm.ClientOptions) (*KustoPoolPrivateLinkResourcesClient, error)`
info	[Changelog] - New function `*KustoPoolPrivateLinkResourcesClient.NewListPager(string, string, string, *KustoPoolPrivateLinkResourcesClientListOptions) *runtime.Pager[KustoPoolPrivateLinkResourcesClientListResponse]`
info	[Changelog] - New struct `ErrorResponseAutoGenerated`
info	[Changelog] - New struct `GetClient`
info	[Changelog] - New struct `IntegrationRuntimeEnableinteractivequery`
info	[Changelog] - New struct `IntegrationRuntimeOperationStatus`
info	[Changelog] - New struct `IntegrationRuntimeStopOperationStatus`
info	[Changelog] - New struct `KustoPoolPrivateLinkResources`
info	[Changelog] - New struct `KustoPoolPrivateLinkResourcesClient`
info	[Changelog] - New struct `KustoPoolPrivateLinkResourcesClientListResponse`
info	[Changelog] - New struct `PrivateLinkResources`
info	[Changelog] - New struct `PrivateLinkResourcesProperties`
info	[Changelog] - New struct `VulnerabilityAssessmentRecurringScansPropertiesAutoGenerated`
info	[Changelog] - New field `IsAutotuneEnabled` in struct `BigDataPoolResourceProperties`
info	[Changelog] - New anonymous field `BigDataPoolResourceInfo` in struct `BigDataPoolsClientDeleteResponse`
info	[Changelog] - New field `AADObjectID` in struct `ClusterPrincipalProperties`
info	[Changelog] - New field `AADObjectID` in struct `DatabasePrincipalProperties`
info	[Changelog] - New anonymous field `IPFirewallRuleInfo` in struct `IPFirewallRulesClientDeleteResponse`
info	[Changelog] - New anonymous field `SQLPool` in struct `SQLPoolOperationResultsClientGetLocationHeaderResultResponse`
info	[Changelog] - New anonymous field `SQLPool` in struct `SQLPoolsClientDeleteResponse`
info	[Changelog] - New anonymous field `SQLPool` in struct `SQLPoolsClientPauseResponse`
info	[Changelog] - New anonymous field `SQLPool` in struct `SQLPoolsClientResumeResponse`
info	[Changelog] - New field `OSType` in struct `SelfHostedIntegrationRuntimeStatusTypeProperties`
info	[Changelog] - New field `TargetFramework` in struct `SelfHostedIntegrationRuntimeStatusTypeProperties`
info	[Changelog] - New field `ConfigMergeRule` in struct `SparkConfigurationInfo`
info	[Changelog] - New anonymous field `Workspace` in struct `WorkspacesClientDeleteResponse`
info	[Changelog]
info	[Changelog] Total 12 breaking change(s), 53 additive change(s).

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs]Release - Generate from b9e0cdd. 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

️✔️synapse [View full logs] [Release Schema Changes]

️❌ azure-powershell failed [Detail]

❌Failed [Logs]Release - Generate from b9e0cdd. 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.synapse [View full logs] [Release SDK Changes]

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

openapi-pipeline-app · 2023-01-10T06:36:25Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/synapse/armsynapse	https://apiview.dev/Assemblies/Review/419809217de74632a1f98e51b82aa29d
Java	azure-resourcemanager-synapse	https://apiview.dev/Assemblies/Review/b14a710cb5cc402e83e2f19739454674
JavaScript	@azure/arm-synapse	https://apiview.dev/Assemblies/Review/d60fa28249984759902f0ae0344bec7f
.Net	Azure.ResourceManager.Synapse	https://apiview.dev/Assemblies/Review/a97ddd75e45c45e8ba04bf282c5d60b7

openapi-workflow-bot · 2023-01-10T06:45:10Z

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

openapi-workflow-bot · 2023-01-10T06:45:10Z

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

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

openapi-workflow-bot · 2023-01-11T08:21:35Z

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

...anager/Microsoft.Synapse/preview/2021-06-01-preview/examples/CreateSqlPoolRestorePoints.json

mikekistler

I found a few minor problems when reviewing breaking changes.

...ation/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json

Swagger Correctness

e9baace

sparatala requested review from wonner and yanjungao718 as code owners January 10, 2023 06:36

openapi-assignment-bot bot assigned ruowan Jan 10, 2023

ghost added the Synapses label Jan 10, 2023

azure-sdk mentioned this pull request Jan 10, 2023

[AutoPR sdk/resourcemanager/synapse/armsynapse] Swagger Correctness azure-sdk/azure-sdk-for-go#3979

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Go label Jan 10, 2023

AzureRestAPISpecReview added CI-FixRequiredOnFailure NewApiVersionRequired resource-manager labels Jan 10, 2023

openapi-pipeline-app bot added the CI-BreakingChange-JavaScript label Jan 10, 2023

azure-sdk mentioned this pull request Jan 10, 2023

[AutoPR Azure.ResourceManager.Synapse] Swagger Correctness azure-sdk/azure-sdk-for-net#2350

Closed

Resolve Model Validation Error

c54fc60

AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required and removed NewApiVersionRequired labels Jan 11, 2023

sparatala added 3 commits January 11, 2023 14:18

Resolve Model Validation error

958d848

Resolve Model Validation Error

7e36e84

Resolve Model Validation Error

910529a

Resolve errors

64e6543

bansalaseem reviewed Jan 24, 2023

View reviewed changes

...anager/Microsoft.Synapse/preview/2021-06-01-preview/examples/CreateSqlPoolRestorePoints.json Show resolved Hide resolved

bansalaseem approved these changes Jan 24, 2023

View reviewed changes

bansalaseem added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jan 24, 2023

mikekistler reviewed Jan 24, 2023

View reviewed changes

sparatala added 2 commits January 25, 2023 12:32

Resolve comments

1dfac31

Resolved model validation errors

3fe6388

JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jan 30, 2023

ruowan added the Approved-LintDiff label Feb 1, 2023

ruowan merged commit b9e0cdd into Azure:main Feb 1, 2023

msyyc mentioned this pull request Apr 21, 2023

[Hub Generated] Review request for Microsoft.Synapse to add version stable/2023-05-01 #23376

Merged

11 tasks

tadelesh mentioned this pull request May 24, 2023

Update sqlServer.json #24140

Merged

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Swagger Correctness #22120

Swagger Correctness #22120

sparatala commented Jan 10, 2023 •

edited by openapi-workflow-bot bot

Loading

openapi-workflow-bot bot commented Jan 10, 2023

openapi-pipeline-app bot commented Jan 10, 2023 •

edited

Loading

openapi-pipeline-app bot commented Jan 10, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Jan 10, 2023 •

edited

Loading

openapi-workflow-bot bot commented Jan 10, 2023

openapi-workflow-bot bot commented Jan 10, 2023

openapi-workflow-bot bot commented Jan 11, 2023

mikekistler left a comment

Swagger Correctness #22120

Swagger Correctness #22120

Conversation

sparatala commented Jan 10, 2023 • edited by openapi-workflow-bot bot Loading

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Jan 10, 2023

openapi-pipeline-app bot commented Jan 10, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jan 10, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Jan 10, 2023 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented Jan 10, 2023

openapi-workflow-bot bot commented Jan 10, 2023

openapi-workflow-bot bot commented Jan 11, 2023

mikekistler left a comment

Choose a reason for hiding this comment

sparatala commented Jan 10, 2023 •

edited by openapi-workflow-bot bot

Loading

openapi-pipeline-app bot commented Jan 10, 2023 •

edited

Loading

openapi-pipeline-app bot commented Jan 10, 2023 •

edited

Loading

openapi-pipeline-app bot commented Jan 10, 2023 •

edited

Loading