Skip to content

Relax Back Compat Method Param Matching #11500

Closed

Description

In our back compat support, we attempt to restore the previous contract's parameter name for service methods. It seems that are matching is too restrictive and several libraries are still having api compat issues do to name changes in parameters. We should relax the param lookup so these edge case scenarios are caught:

Sample library:

##[error]D:\a\_work\1\s\eng\Directory.Build.Common.targets(527,5): error : API compatibility errors between 'lib/netstandard2.0/Azure.ResourceManager.Redis.dll' (left) and 'lib/netstandard2.0/Azure.ResourceManager.Redis.dll' (right): [D:\a\_work\1\s\sdk\redis\Azure.ResourceManager.Redis\src\Azure.ResourceManager.Redis.csproj::TargetFramework=net10.0]
##[error]D:\a\_work\1\s\eng\Directory.Build.Common.targets(527,5): error CP0017: Parameter name on member 'Azure.ResourceManager.Redis.RedisResource.GetRedisPatchScheduleAsync(Azure.ResourceManager.Redis.Models.RedisPatchScheduleDefaultName, System.Threading.CancellationToken)' changed from 'defaultName' to 'default'. [D:\a\_work\1\s\sdk\redis\Azure.ResourceManager.Redis\src\Azure.ResourceManager.Redis.csproj::TargetFramework=net10.0]
##[error]D:\a\_work\1\s\eng\Directory.Build.Common.targets(527,5): error CP0017: Parameter name on member 'Azure.ResourceManager.Redis.RedisResource.GetRedisPatchSchedule(Azure.ResourceManager.Redis.Models.RedisPatchScheduleDefaultName, System.Threading.CancellationToken)' changed from 'defaultName' to 'default'. [D:\a\_work\1\s\sdk\redis\Azure.ResourceManager.Redis\src\Azure.ResourceManager.Redis.csproj::TargetFramework=net10.0]
##[error]D:\a\_work\1\s\eng\Directory.Build.Common.targets(527,5): error CP0017: Parameter name on member 'Azure.ResourceManager.Redis.RedisPatchScheduleCollection.CreateOrUpdateAsync(Azure.WaitUntil, Azure.ResourceManager.Redis.Models.RedisPatchScheduleDefaultName, Azure.ResourceManager.Redis.RedisPatchScheduleData, System.Threading.CancellationToken)' changed from 'defaultName' to 'default'. [D:\a\_work\1\s\sdk\redis\Azure.ResourceManager.Redis\src\Azure.ResourceManager.Redis.csproj::TargetFramework=net10.0]
##[error]D:\a\_work\1\s\eng\Directory.Build.Common.targets(527,5): error CP0017: Parameter name on member 'Azure.ResourceManager.Redis.RedisPatchScheduleCollection.CreateOrUpdate(Azure.WaitUntil, Azure.ResourceManager.Redis.Models.RedisPatchScheduleDefaultName, Azure.ResourceManager.Redis.RedisPatchScheduleData, System.Threading.CancellationToken)' changed from 'defaultName' to 'default'. [D:\a\_work\1\s\sdk\redis\Azure.ResourceManager.Redis\src\Azure.ResourceManager.Redis.csproj::TargetFramework=net10.0]
##[error]D:\a\_work\1\s\eng\Directory.Build.Common.targets(527,5): error CP0017: Parameter name on member 'Azure.ResourceManager.Redis.RedisPatchScheduleCollection.GetAsync(Azure.ResourceManager.Redis.Models.RedisPatchScheduleDefaultName, System.Threading.CancellationToken)' changed from 'defaultName' to 'default'. [D:\a\_work\1\s\sdk\redis\Azure.ResourceManager.Redis\src\Azure.ResourceManager.Redis.csproj::TargetFramework=net10.0]
##[error]D:\a\_work\1\s\eng\Directory.Build.Common.targets(527,5): error CP0017: Parameter name on member 'Azure.ResourceManager.Redis.RedisPatchScheduleCollection.Get(Azure.ResourceManager.Redis.Models.RedisPatchScheduleDefaultName, System.Threading.CancellationToken)' changed from 'defaultName' to 'default'. [D:\a\_work\1\s\sdk\redis\Azure.ResourceManager.Redis\src\Azure.ResourceManager.Redis.csproj::TargetFramework=net10.0]
##[error]D:\a\_work\1\s\eng\Directory.Build.Common.targets(527,5): error CP0017: Parameter name on member 'Azure.ResourceManager.Redis.RedisPatchScheduleCollection.ExistsAsync(Azure.ResourceManager.Redis.Models.RedisPatchScheduleDefaultName, System.Threading.CancellationToken)' changed from 'defaultName' to 'default'. [D:\a\_work\1\s\sdk\redis\Azure.ResourceManager.Redis\src\Azure.ResourceManager.Redis.csproj::TargetFramework=net10.0]
##[error]D:\a\_work\1\s\eng\Directory.Build.Common.targets(527,5): error CP0017: Parameter name on member 'Azure.ResourceManager.Redis.RedisPatchScheduleCollection.Exists(Azure.ResourceManager.Redis.Models.RedisPatchScheduleDefaultName, System.Threading.CancellationToken)' changed from 'defaultName' to 'default'. [D:\a\_work\1\s\sdk\redis\Azure.ResourceManager.Redis\src\Azure.ResourceManager.Redis.csproj::TargetFramework=net10.0]
##[error]D:\a\_work\1\s\eng\Directory.Build.Common.targets(527,5): error CP0017: Parameter name on member 'Azure.ResourceManager.Redis.RedisPatchScheduleCollection.GetIfExistsAsync(Azure.ResourceManager.Redis.Models.RedisPatchScheduleDefaultName, System.Threading.CancellationToken)' changed from 'defaultName' to 'default'. [D:\a\_work\1\s\sdk\redis\Azure.ResourceManager.Redis\src\Azure.ResourceManager.Redis.csproj::TargetFramework=net10.0]
##[error]D:\a\_work\1\s\eng\Directory.Build.Common.targets(527,5): error CP0017: Parameter name on member 'Azure.ResourceManager.Redis.RedisPatchScheduleCollection.GetIfExists(Azure.ResourceManager.Redis.Models.RedisPatchScheduleDefaultName, System.Threading.CancellationToken)' changed from 'defaultName' to 'default'. [D:\a\_work\1\s\sdk\redis\Azure.ResourceManager.Redis\src\Azure.ResourceManager.Redis.csproj::TargetFramework=net10.0]
##[error]D:\a\_work\1\s\eng\Directory.Build.Common.targets(527,5): error : API breaking changes found. If those are intentional, the APICompat suppression file can be updated by rebuilding with '/p:ApiCompatGenerateSuppressionFile=true' [D:\a\_work\1\s\sdk\redis\Azure.ResourceManager.Redis\src\Azure.ResourceManager.Redis.csproj::TargetFramework=net10.0]

Activity

  1. github-actions commented on Jul 30, 2026

    @github-actions
    Contributor

    🎯 Issue Triage

    The C# client emitter's back-compat parameter name restoration logic is too restrictive, missing edge cases where parameter names changed (e.g., defaultName → default), resulting in CP0017 API compatibility errors in generated Azure SDK libraries.

    Category: Feature Request

    Area: emitter:client:csharp

    🔍 Analysis
    • The back-compat support attempts to restore the previous contract's parameter names for service methods, but the parameter lookup logic fails for certain naming edge cases.
    • The example shows defaultName renamed to default (a reserved keyword in C#) across multiple methods in Azure.ResourceManager.Redis (GetRedisPatchSchedule, CreateOrUpdate, Get, Exists, GetIfExists variants).
    • The fix involves relaxing the param matching/lookup so these renamed parameters are still found and mapped correctly.
    • Related: [csharp] Generated back-compat overloads in ModelFactory can have non-compiling bodies after large signature changes #10595 — which covers non-compiling back-compat overload bodies in ModelFactory; the two issues share the back-compat overload generation area but describe different failure modes.
    📝 Suggested next steps
    • Identify the parameter name lookup logic in the back-compat overload generation code for the C# emitter
    • Add a relaxed/fuzzy matching strategy (e.g., case-insensitive, reserved-keyword normalization) for parameter name resolution
    • Add test coverage for the defaultName → default rename scenario and similar edge cases
    • Validate with Azure.ResourceManager.Redis as a regression test

    Generated by Agentic Triage

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

emitter:client:csharpIssue for the C# client emitter: @typespec/http-client-csharpfeatureNew feature or request

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions