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

Remove space of "IPv6 FirewallRule" in Microsoft.SQL 2023-05-01-preview #26511

Merged
merged 1 commit into from
Nov 15, 2023

Conversation

ericshape
Copy link
Contributor

@ericshape ericshape commented Nov 1, 2023

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.

diagram

[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!

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:

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

Copy link

openapi-pipeline-app bot commented Nov 1, 2023

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).

Copy link

openapi-pipeline-app bot commented Nov 1, 2023

Swagger Validation Report

️❌BreakingChange: 6 Errors, 0 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
IPv6FirewallRules.json 2023-05-01-preview(3d58510) 2023-05-01-preview(main)
Rule Message
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'IPv6 FirewallRule' removed or renamed?
New: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L214:3
Old: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L214:3
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L238:11
Old: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L238:11
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L92:13
Old: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L92:13
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L131:13
Old: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L131:13
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L145:13
Old: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L145:13
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L154:13
Old: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L154:13
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 1 Errors, 0 Warnings failed [Detail]
compared tags (via openapi-validator v2.1.6) new version base version
package-preview-2023-05 package-preview-2023-05(3d58510) package-preview-2023-05(main)

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

Rule Message Related RPC [For API reviewers]
RequiredPropertiesMissingInResourceModel Model definition 'IPv6FirewallRule' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
Location: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L215
RPC-Get-V1-03, RPC-Put-V1-08


The following errors/warnings exist before current PR submission:

Rule Message
ResourceNameRestriction The resource name parameter 'serverName' should be defined with a 'pattern' restriction.
Location: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L19
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L47
ResourceNameRestriction The resource name parameter 'serverName' should be defined with a 'pattern' restriction.
Location: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L61
ResourceNameRestriction The resource name parameter 'firewallRuleName' should be defined with a 'pattern' restriction.
Location: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L61
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L96
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L149
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L199
⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
Location: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L26
⚠️ RequiredReadOnlySystemData The response of operation:'IPv6FirewallRules_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L62
⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
Location: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L68
⚠️ RequiredReadOnlySystemData The response of operation:'IPv6FirewallRules_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L106
⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
Location: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L112
⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
Location: Microsoft.Sql/preview/2023-05-01-preview/IPv6FirewallRules.json#L174
️⚠️Avocado: 1 Warnings warning [Detail]
Rule Message
⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
readme: specification/sql/resource-manager/readme.md
tag: specification/sql/resource-manager/readme.md#tag-package-composite-v5
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView 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).
️️✔️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?

Copy link

openapi-pipeline-app bot commented Nov 1, 2023

Swagger Generation Artifacts

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

Breaking Changes Tracking



️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from fc4168a. 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: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    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.3
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.3>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-sql [View full logs]  [Release SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog]   - Added operation group JobPrivateEndpointsOperations
    info	[Changelog]   - Model FailoverGroupReadOnlyEndpoint has a new parameter target_server
    info	[Changelog]   - Model FailoverGroupUpdate has a new parameter partner_servers
    info	[Changelog]   - Model InstancePool has a new parameter dns_zone
    info	[Changelog]   - Model InstancePool has a new parameter maintenance_configuration_id
    info	[Changelog]   - Model InstancePoolUpdate has a new parameter dns_zone
    info	[Changelog]   - Model InstancePoolUpdate has a new parameter license_type
    info	[Changelog]   - Model InstancePoolUpdate has a new parameter maintenance_configuration_id
    info	[Changelog]   - Model InstancePoolUpdate has a new parameter sku
    info	[Changelog]   - Model InstancePoolUpdate has a new parameter subnet_id
    info	[Changelog]   - Model InstancePoolUpdate has a new parameter v_cores
    info	[Changelog]   - Model Server has a new parameter is_i_pv6_enabled
    info	[Changelog]   - Model ServerUpdate has a new parameter is_i_pv6_enabled
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from fc4168a. 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.Sql [View full logs]  [Release SDK Changes]
    info	[Changelog]
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from fc4168a. 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.3.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.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
  • ️✔️azure-resourcemanager-sql-generated [View full logs]  [Release SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from fc4168a. 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/sql/armsql [View full logs]  [Release SDK Changes] Breaking Change Detected
    info	[Changelog] ### Breaking Changes
    info	[Changelog]
    info	[Changelog] - Function `timeRFC3339.MarshalText` has been removed
    info	[Changelog] - Function `*timeRFC3339.Parse` has been removed
    info	[Changelog] - Function `*timeRFC3339.UnmarshalText` has been removed
    info	[Changelog]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New function `*ClientFactory.NewJobPrivateEndpointsClient() *JobPrivateEndpointsClient`
    info	[Changelog] - New function `NewJobPrivateEndpointsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*JobPrivateEndpointsClient, error)`
    info	[Changelog] - New function `*JobPrivateEndpointsClient.BeginCreateOrUpdate(context.Context, string, string, string, string, JobPrivateEndpoint, *JobPrivateEndpointsClientBeginCreateOrUpdateOptions) (*runtime.Poller[JobPrivateEndpointsClientCreateOrUpdateResponse], error)`
    info	[Changelog] - New function `*JobPrivateEndpointsClient.BeginDelete(context.Context, string, string, string, string, *JobPrivateEndpointsClientBeginDeleteOptions) (*runtime.Poller[JobPrivateEndpointsClientDeleteResponse], error)`
    info	[Changelog] - New function `*JobPrivateEndpointsClient.Get(context.Context, string, string, string, string, *JobPrivateEndpointsClientGetOptions) (JobPrivateEndpointsClientGetResponse, error)`
    info	[Changelog] - New function `*JobPrivateEndpointsClient.NewListByAgentPager(string, string, string, *JobPrivateEndpointsClientListByAgentOptions) *runtime.Pager[JobPrivateEndpointsClientListByAgentResponse]`
    info	[Changelog] - New function `dateTimeRFC3339.MarshalText() ([]byte, error)`
    info	[Changelog] - New function `*dateTimeRFC3339.Parse(string) error`
    info	[Changelog] - New function `*dateTimeRFC3339.UnmarshalText([]byte) error`
    info	[Changelog] - New struct `JobPrivateEndpoint`
    info	[Changelog] - New struct `JobPrivateEndpointListResult`
    info	[Changelog] - New struct `JobPrivateEndpointProperties`
    info	[Changelog] - New field `DNSZone`, `MaintenanceConfigurationID` in struct `InstancePoolProperties`
    info	[Changelog] - New field `Properties`, `SKU` in struct `InstancePoolUpdate`
    info	[Changelog]
    info	[Changelog] Total 3 breaking change(s), 17 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from fc4168a. 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-sql [View full logs]  [Release SDK Changes]
    info	[Changelog] **Features**
    info	[Changelog]
    info	[Changelog]   - Added operation group JobPrivateEndpoints
    info	[Changelog]   - Added operation FailoverGroups.beginTryPlannedBeforeForcedFailover
    info	[Changelog]   - Added operation FailoverGroups.beginTryPlannedBeforeForcedFailoverAndWait
    info	[Changelog]   - Added Interface FailoverGroupsTryPlannedBeforeForcedFailoverHeaders
    info	[Changelog]   - Added Interface FailoverGroupsTryPlannedBeforeForcedFailoverOptionalParams
    info	[Changelog]   - Added Interface JobPrivateEndpoint
    info	[Changelog]   - Added Interface JobPrivateEndpointListResult
    info	[Changelog]   - Added Interface JobPrivateEndpointsCreateOrUpdateOptionalParams
    info	[Changelog]   - Added Interface JobPrivateEndpointsDeleteOptionalParams
    info	[Changelog]   - Added Interface JobPrivateEndpointsGetOptionalParams
    info	[Changelog]   - Added Interface JobPrivateEndpointsListByAgentNextOptionalParams
    info	[Changelog]   - Added Interface JobPrivateEndpointsListByAgentOptionalParams
    info	[Changelog]   - Added Type Alias FailoverGroupsTryPlannedBeforeForcedFailoverResponse
    info	[Changelog]   - Added Type Alias FreeLimitExhaustionBehavior
    info	[Changelog]   - Added Type Alias JobPrivateEndpointsCreateOrUpdateResponse
    info	[Changelog]   - Added Type Alias JobPrivateEndpointsGetResponse
    info	[Changelog]   - Added Type Alias JobPrivateEndpointsListByAgentNextResponse
    info	[Changelog]   - Added Type Alias JobPrivateEndpointsListByAgentResponse
    info	[Changelog]   - Interface Database has a new optional parameter encryptionProtectorAutoRotation
    info	[Changelog]   - Interface Database has a new optional parameter freeLimitExhaustionBehavior
    info	[Changelog]   - Interface Database has a new optional parameter useFreeLimit
    info	[Changelog]   - Interface DatabaseUpdate has a new optional parameter encryptionProtectorAutoRotation
    info	[Changelog]   - Interface DatabaseUpdate has a new optional parameter freeLimitExhaustionBehavior
    info	[Changelog]   - Interface DatabaseUpdate has a new optional parameter useFreeLimit
    info	[Changelog]   - Interface ElasticPool has a new optional parameter availabilityZone
    info	[Changelog]   - Interface ElasticPool has a new optional parameter minCapacity
    info	[Changelog]   - Interface ElasticPool has a new optional parameter preferredEnclaveType
    info	[Changelog]   - Interface ElasticPoolUpdate has a new optional parameter availabilityZone
    info	[Changelog]   - Interface ElasticPoolUpdate has a new optional parameter minCapacity
    info	[Changelog]   - Interface ElasticPoolUpdate has a new optional parameter preferredEnclaveType
    info	[Changelog]   - Interface FailoverGroupReadOnlyEndpoint has a new optional parameter targetServer
    info	[Changelog]   - Interface FailoverGroupUpdate has a new optional parameter partnerServers
    info	[Changelog]   - Interface InstancePool has a new optional parameter dnsZone
    info	[Changelog]   - Interface InstancePool has a new optional parameter maintenanceConfigurationId
    info	[Changelog]   - Interface InstancePoolUpdate has a new optional parameter dnsZone
    info	[Changelog]   - Interface InstancePoolUpdate has a new optional parameter licenseType
    info	[Changelog]   - Interface InstancePoolUpdate has a new optional parameter maintenanceConfigurationId
    info	[Changelog]   - Interface InstancePoolUpdate has a new optional parameter sku
    info	[Changelog]   - Interface InstancePoolUpdate has a new optional parameter subnetId
    info	[Changelog]   - Interface InstancePoolUpdate has a new optional parameter vCores
    info	[Changelog]   - Interface ManagedDatabase has a new optional parameter isLedgerOn
    info	[Changelog]   - Interface ManagedDatabaseUpdate has a new optional parameter isLedgerOn
    info	[Changelog]   - Interface PrivateEndpointConnection has a new optional parameter groupIds
    info	[Changelog]   - Interface Server has a new optional parameter isIPv6Enabled
    info	[Changelog]   - Interface ServerUpdate has a new optional parameter isIPv6Enabled
    info	[Changelog]   - Interface SqlVulnerabilityAssessmentScanRecord has a new optional parameter lastScanTime
    info	[Changelog]   - Added Enum KnownFreeLimitExhaustionBehavior
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from fc4168a. 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.3
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.3>
    cmderr	[initScript.sh] npm notice Run `npm install -g [email protected]` 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
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs]Release - Generate from fc4168a. 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.sql.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.sql.DefaultTag
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Nov 1, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/sql/armsql https://apiview.dev/Assemblies/Review/7d802e42a79c4a36a882207f642e019e
.Net Azure.ResourceManager.Sql https://apiview.dev/Assemblies/Review/955c8a67e89247f499642dea5b303dac
JavaScript @azure/arm-sql https://apiview.dev/Assemblies/Review/42eefdbf04cc4ad79f54585a44105038

@AzureRestAPISpecReview AzureRestAPISpecReview added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required resource-manager labels Nov 1, 2023
Copy link

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.

@ericshape
Copy link
Contributor Author

ericshape commented Nov 1, 2023

Obviously, removing space char in a resource name def would break downstream clients.

The breaking change discussion in #26303
#26303 (comment)
#26303 (comment)

@ericshape whilst we strive to use the latest API version, unfortunately that's not always possible and sometimes we do need to use an older API version.

Since this bug affects all of these APIs (and now the next version 2023-05-01-preview) - it made sense to fix this in all applicable API versions, since this isn't a breaking change (as autorest is stripping invalid characters from the model names).

@mikekistler @JeffreyRichter whilst spaces within identifiers are being stripped from model names by autorest, should that be raised as an error by the linter? I can't think of a scenario where a space (or even other characters such as [ and ]) would be useful in identifiers, and whilst autorest is stripping this out, it feels like the source data should be fixed rather than these values being silently removed - WDYT?

Agreed that the source data should be fixed. The data plane validation will flag cases like this with this rule:

https://github.com/Azure/azure-openapi-validator/blob/main/docs/schema-names-convention.md

This is apparently not enabled for ARM APIs.

@ms-henglu
Copy link
Member

There are a bunch of breaking changes reported on this PR. Please get a breaking changes approval from Azure Breaking Changes Reviewers [email protected] and ARM can review the changes afterwards. Once you have the approval, please remove the "ARMChangesRequested" label from the PR to make the PR visible to the ARM reviewers.

@tombuildsstuff
Copy link
Contributor

@ms-henglu spaces aren't valid in identifiers in any programming language that I'm aware of - else the compilation would fail.

Given SDKs are already shipping with these model names in multiple languages (which don't contain spaces (example) since AutoRest is removing them, as mentioned above) - this is obviously not a breaking change - but instead yet another bug in the breaking change detector tool.

So, does this really need to go through that process, involving multiple people - when this is clearly a false-positive - and when this has already been approved once in #26303?

@mikekistler mikekistler added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Nov 14, 2023
@mikekistler
Copy link
Member

Breaking change previously reviewed and approved in #26303

@ms-henglu ms-henglu added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Nov 14, 2023
@openapi-workflow-bot openapi-workflow-bot bot removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Nov 14, 2023
@ericshape
Copy link
Contributor Author

/azp run

Copy link

Azure Pipelines successfully started running 3 pipeline(s).

@ericshape
Copy link
Contributor Author

/pr RequestMerge

@ms-henglu ms-henglu merged commit fc4168a into main Nov 15, 2023
29 of 31 checks passed
@ms-henglu ms-henglu deleted the remove_space_IPv6_FirewallRule branch November 15, 2023 04:07
Copy link

Swagger pipeline restarted successfully, please wait for status update in this comment.

@ericshape
Copy link
Contributor Author

@ms-henglu spaces aren't valid in identifiers in any programming language that I'm aware of - else the compilation would fail.

Given SDKs are already shipping with these model names in multiple languages (which don't contain spaces (example) since AutoRest is removing them, as mentioned above) - this is obviously not a breaking change - but instead yet another bug in the breaking change detector tool.

So, does this really need to go through that process, involving multiple people - when this is clearly a false-positive - and when this has already been approved once in #26303?

@tombuildsstuff the PR has been merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-LintDiff Approved-SdkBreakingChange-Python ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-BreakingChange-Go resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants