Skip to content

fix: generate parameterized accessor for subclients with subclient-specific parameters #9919

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.

Sign up for GitHub

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

Merged
JoshLove-msft merged 13 commits into from
Mar 6, 2026
Merged

fix: generate parameterized accessor for subclients with subclient-specific parameters #9919

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
1389cb6
Initial plan
Copilot Mar 4, 2026
624a489
fix(http-client-js): include subclient parameters in accessor methods
Copilot Mar 4, 2026
533c12b
fix(http-client-csharp): include subclient parameters in accessor met…
Copilot Mar 4, 2026
8c982c7
revert: restore http-client-js/CHANGELOG.md to original state
Copilot Mar 4, 2026
08eb7b2
chore: delete stale http-client-csharp changeset file
Copilot Mar 4, 2026
afdc1da
fix: parameterized accessor for IndividuallyParent subclients with ac…
Copilot Mar 4, 2026
d716f43
revert: remove Spector azure test project per review feedback
Copilot Mar 4, 2026
dd06669
style: run prettier on SampleService/main.tsp
Copilot Mar 4, 2026
cb0f232
chore: regenerate Sample-TypeSpec after Generate.ps1
Copilot Mar 5, 2026
5166912
Changes before error encountered
Copilot Mar 5, 2026
8d161f2
refactor: simplify subclient accessor params - remove propagation det…
Copilot Mar 5, 2026
4cbd977
fix: add MetricsClientParams back to main.tsp and regenerate samples
JoshLove-msft Mar 6, 2026
4a4e7a8
refactor: simplify subclient parameter comparison logic in accessor g…
JoshLove-msft Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/samples/client/csharp/SampleService/SampleClient/src/Generated/Metrics.RestClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ internal PipelineMessage CreateGetWidgetMetricsRequest(string day, RequestOption
{
ClientUriBuilder uri = new ClientUriBuilder();
uri.Reset(_endpoint);
uri.AppendPath("/metrics/widgets/daysOfWeek/", false);
uri.AppendPath("/metrics/", false);
uri.AppendPath(_metricsNamespace, true);
uri.AppendPath("/widgets/daysOfWeek/", false);
uri.AppendPath(day, true);
PipelineMessage message = Pipeline.CreateMessage(uri.ToUri(), "GET", PipelineMessageClassifier200);
PipelineRequest request = message.Request;
Expand Down
19 changes: 14 additions & 5 deletions docs/samples/client/csharp/SampleService/SampleClient/src/Generated/Metrics.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ namespace SampleTypeSpec
public partial class Metrics
{
private readonly Uri _endpoint;
private readonly string _metricsNamespace;

/// <summary> Initializes a new instance of Metrics for mocking. </summary>
protected Metrics()
Expand All @@ -23,30 +24,38 @@ protected Metrics()
/// <summary> Initializes a new instance of Metrics. </summary>
/// <param name="pipeline"> The HTTP pipeline for sending and receiving REST requests and responses. </param>
/// <param name="endpoint"> Service endpoint. </param>
internal Metrics(ClientPipeline pipeline, Uri endpoint)
/// <param name="metricsNamespace"></param>
internal Metrics(ClientPipeline pipeline, Uri endpoint, string metricsNamespace)
{
_endpoint = endpoint;
Pipeline = pipeline;
_metricsNamespace = metricsNamespace;
}

/// <summary> Initializes a new instance of Metrics. </summary>
/// <param name="endpoint"> Service endpoint. </param>
/// <exception cref="ArgumentNullException"> <paramref name="endpoint"/> is null. </exception>
public Metrics(Uri endpoint) : this(endpoint, new SampleTypeSpecClientOptions())
/// <param name="metricsNamespace"></param>
/// <exception cref="ArgumentNullException"> <paramref name="endpoint"/> or <paramref name="metricsNamespace"/> is null. </exception>
/// <exception cref="ArgumentException"> <paramref name="metricsNamespace"/> is an empty string, and was expected to be non-empty. </exception>
public Metrics(Uri endpoint, string metricsNamespace) : this(endpoint, metricsNamespace, new SampleTypeSpecClientOptions())
{
}

/// <summary> Initializes a new instance of Metrics. </summary>
/// <param name="endpoint"> Service endpoint. </param>
/// <param name="metricsNamespace"></param>
/// <param name="options"> The options for configuring the client. </param>
/// <exception cref="ArgumentNullException"> <paramref name="endpoint"/> is null. </exception>
public Metrics(Uri endpoint, SampleTypeSpecClientOptions options)
/// <exception cref="ArgumentNullException"> <paramref name="endpoint"/> or <paramref name="metricsNamespace"/> is null. </exception>
/// <exception cref="ArgumentException"> <paramref name="metricsNamespace"/> is an empty string, and was expected to be non-empty. </exception>
public Metrics(Uri endpoint, string metricsNamespace, SampleTypeSpecClientOptions options)
{
Argument.AssertNotNull(endpoint, nameof(endpoint));
Argument.AssertNotNullOrEmpty(metricsNamespace, nameof(metricsNamespace));

options ??= new SampleTypeSpecClientOptions();

_endpoint = endpoint;
_metricsNamespace = metricsNamespace;
Pipeline = ClientPipeline.Create(options, Array.Empty<PipelinePolicy>(), new PipelinePolicy[] { new UserAgentPolicy(typeof(Metrics).Assembly) }, Array.Empty<PipelinePolicy>());
}

Expand Down
31 changes: 22 additions & 9 deletions docs/samples/client/csharp/SampleService/SampleClient/src/Generated/SampleTypeSpecClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ public partial class SampleTypeSpecClient
}
};
private readonly string _apiVersion;
private readonly string _metricsNamespace;
private AnimalOperations _cachedAnimalOperations;
private PetOperations _cachedPetOperations;
private DogOperations _cachedDogOperations;
Expand All @@ -45,51 +46,63 @@ protected SampleTypeSpecClient()

/// <summary> Initializes a new instance of SampleTypeSpecClient. </summary>
/// <param name="endpoint"> Service endpoint. </param>
/// <param name="metricsNamespace"></param>
/// <param name="credential"> A credential used to authenticate to the service. </param>
/// <exception cref="ArgumentNullException"> <paramref name="endpoint"/> or <paramref name="credential"/> is null. </exception>
public SampleTypeSpecClient(Uri endpoint, ApiKeyCredential credential) : this(endpoint, credential, new SampleTypeSpecClientOptions())
/// <exception cref="ArgumentNullException"> <paramref name="endpoint"/>, <paramref name="metricsNamespace"/> or <paramref name="credential"/> is null. </exception>
/// <exception cref="ArgumentException"> <paramref name="metricsNamespace"/> is an empty string, and was expected to be non-empty. </exception>
public SampleTypeSpecClient(Uri endpoint, string metricsNamespace, ApiKeyCredential credential) : this(endpoint, metricsNamespace, credential, new SampleTypeSpecClientOptions())
Comment thread
JoshLove-msft marked this conversation as resolved.
{
}

/// <summary> Initializes a new instance of SampleTypeSpecClient. </summary>
/// <param name="endpoint"> Service endpoint. </param>
/// <param name="metricsNamespace"></param>
/// <param name="tokenProvider"> A credential provider used to authenticate to the service. </param>
/// <exception cref="ArgumentNullException"> <paramref name="endpoint"/> or <paramref name="tokenProvider"/> is null. </exception>
public SampleTypeSpecClient(Uri endpoint, AuthenticationTokenProvider tokenProvider) : this(endpoint, tokenProvider, new SampleTypeSpecClientOptions())
/// <exception cref="ArgumentNullException"> <paramref name="endpoint"/>, <paramref name="metricsNamespace"/> or <paramref name="tokenProvider"/> is null. </exception>
/// <exception cref="ArgumentException"> <paramref name="metricsNamespace"/> is an empty string, and was expected to be non-empty. </exception>
public SampleTypeSpecClient(Uri endpoint, string metricsNamespace, AuthenticationTokenProvider tokenProvider) : this(endpoint, metricsNamespace, tokenProvider, new SampleTypeSpecClientOptions())
{
}

/// <summary> Initializes a new instance of SampleTypeSpecClient. </summary>
/// <param name="endpoint"> Service endpoint. </param>
/// <param name="metricsNamespace"></param>
/// <param name="credential"> A credential used to authenticate to the service. </param>
/// <param name="options"> The options for configuring the client. </param>
/// <exception cref="ArgumentNullException"> <paramref name="endpoint"/> or <paramref name="credential"/> is null. </exception>
public SampleTypeSpecClient(Uri endpoint, ApiKeyCredential credential, SampleTypeSpecClientOptions options)
/// <exception cref="ArgumentNullException"> <paramref name="endpoint"/>, <paramref name="metricsNamespace"/> or <paramref name="credential"/> is null. </exception>
/// <exception cref="ArgumentException"> <paramref name="metricsNamespace"/> is an empty string, and was expected to be non-empty. </exception>
public SampleTypeSpecClient(Uri endpoint, string metricsNamespace, ApiKeyCredential credential, SampleTypeSpecClientOptions options)
Comment thread
JoshLove-msft marked this conversation as resolved.
{
Argument.AssertNotNull(endpoint, nameof(endpoint));
Argument.AssertNotNullOrEmpty(metricsNamespace, nameof(metricsNamespace));
Argument.AssertNotNull(credential, nameof(credential));

options ??= new SampleTypeSpecClientOptions();

_endpoint = endpoint;
_metricsNamespace = metricsNamespace;
_keyCredential = credential;
Pipeline = ClientPipeline.Create(options, Array.Empty<PipelinePolicy>(), new PipelinePolicy[] { new UserAgentPolicy(typeof(SampleTypeSpecClient).Assembly), ApiKeyAuthenticationPolicy.CreateHeaderApiKeyPolicy(_keyCredential, AuthorizationHeader) }, Array.Empty<PipelinePolicy>());
_apiVersion = options.Version;
}

/// <summary> Initializes a new instance of SampleTypeSpecClient. </summary>
/// <param name="endpoint"> Service endpoint. </param>
/// <param name="metricsNamespace"></param>
/// <param name="tokenProvider"> A credential provider used to authenticate to the service. </param>
/// <param name="options"> The options for configuring the client. </param>
/// <exception cref="ArgumentNullException"> <paramref name="endpoint"/> or <paramref name="tokenProvider"/> is null. </exception>
public SampleTypeSpecClient(Uri endpoint, AuthenticationTokenProvider tokenProvider, SampleTypeSpecClientOptions options)
/// <exception cref="ArgumentNullException"> <paramref name="endpoint"/>, <paramref name="metricsNamespace"/> or <paramref name="tokenProvider"/> is null. </exception>
/// <exception cref="ArgumentException"> <paramref name="metricsNamespace"/> is an empty string, and was expected to be non-empty. </exception>
public SampleTypeSpecClient(Uri endpoint, string metricsNamespace, AuthenticationTokenProvider tokenProvider, SampleTypeSpecClientOptions options)
{
Argument.AssertNotNull(endpoint, nameof(endpoint));
Argument.AssertNotNullOrEmpty(metricsNamespace, nameof(metricsNamespace));
Argument.AssertNotNull(tokenProvider, nameof(tokenProvider));

options ??= new SampleTypeSpecClientOptions();

_endpoint = endpoint;
_metricsNamespace = metricsNamespace;
_tokenProvider = tokenProvider;
Pipeline = ClientPipeline.Create(options, Array.Empty<PipelinePolicy>(), new PipelinePolicy[] { new UserAgentPolicy(typeof(SampleTypeSpecClient).Assembly), new BearerTokenPolicy(_tokenProvider, _flows) }, Array.Empty<PipelinePolicy>());
_apiVersion = options.Version;
Expand Down Expand Up @@ -3317,7 +3330,7 @@ public virtual PlantOperations GetPlantOperationsClient()
/// <summary> Initializes a new instance of Metrics. </summary>
public virtual Metrics GetMetricsClient()
{
return Volatile.Read(ref _cachedMetrics) ?? Interlocked.CompareExchange(ref _cachedMetrics, new Metrics(Pipeline, _endpoint), null) ?? _cachedMetrics;
return Volatile.Read(ref _cachedMetrics) ?? Interlocked.CompareExchange(ref _cachedMetrics, new Metrics(Pipeline, _endpoint, _metricsNamespace), null) ?? _cachedMetrics;
}
}
}
9 changes: 7 additions & 2 deletions docs/samples/client/csharp/SampleService/main.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -833,14 +833,19 @@ interface PlantOperations {
};
}

model MetricsClientParams {
metricsNamespace: string;
}

@clientInitialization({
Comment thread
JoshLove-msft marked this conversation as resolved.
initializedBy: InitializedBy.individually | InitializedBy.parent,
parameters: MetricsClientParams,
})
interface Metrics {
@doc("Get Widget metrics for given day of week")
@get
@route("/metrics/widgets/daysOfWeek")
getWidgetMetrics(@path day: DaysOfWeekExtensibleEnum): {
@route("/metrics/{metricsNamespace}/widgets/daysOfWeek")
getWidgetMetrics(@path metricsNamespace: string, @path day: DaysOfWeekExtensibleEnum): {
numSold: int32;
averagePrice: float32;
};
Expand Down
Loading
Loading