Skip to content

csharp-model-suffix

Id
@azure-tools/typespec-client-generator-core/csharp-model-suffix

Model names should use recommended suffixes for C# SDKs.

C# SDK model names should use these recommended suffixes:

  • Use Config instead of Options, except for client options.
  • Use Content instead of Request.
  • Use Result instead of Response.

The rule checks the C#-resolved model name and respects @clientName overrides.

model SearchOptions {
filter: string;
}
model CreateWidgetRequest {
name: string;
}
model CreateWidgetResponse {
id: string;
}
model SearchConfig {
filter: string;
}
model CreateWidgetContent {
name: string;
}
model CreateWidgetResult {
id: string;
}

Or using @@clientName in client.tsp to override just the C# name:

client.tsp
@@clientName(SearchOptions, "SearchConfig", "csharp");
@@clientName(CreateWidgetRequest, "CreateWidgetContent", "csharp");
@@clientName(CreateWidgetResponse, "CreateWidgetResult", "csharp");