Skip to content

Commit c396ce1

Browse files
Copilotlive1206
andauthored
Fix Update method documentation to say "Update" instead of "Create" (Azure#53469)
* Initial plan * Fix Update method documentation to say "Update" instead of "Create" Co-authored-by: live1206 <[email protected]> * Only override description for Create operations used as Update Co-authored-by: live1206 <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: live1206 <[email protected]>
1 parent 8cb1367 commit c396ce1

File tree

3 files changed

+23
-10
lines changed

3 files changed

+23
-10
lines changed

eng/packages/http-client-csharp-mgmt/generator/Azure.Generator.Management/src/Providers/OperationMethodProviders/UpdateOperationMethodProvider.cs

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,28 @@
33

44
using Azure.Generator.Management.Models;
55
using Microsoft.TypeSpec.Generator.Input;
6+
using System;
7+
using System.Runtime.CompilerServices;
68

79
namespace Azure.Generator.Management.Providers.OperationMethodProviders
810
{
9-
internal class UpdateOperationMethodProvider(
10-
ResourceClientProvider resource,
11-
RequestPathPattern contextualPath,
12-
RestClientInfo restClientInfo,
13-
InputServiceMethod method,
14-
bool isAsync) : ResourceOperationMethodProvider(resource, contextualPath, restClientInfo, method, isAsync, methodName: isAsync ? "UpdateAsync" : "Update")
11+
internal class UpdateOperationMethodProvider : ResourceOperationMethodProvider
1512
{
13+
public UpdateOperationMethodProvider(
14+
ResourceClientProvider resource,
15+
RequestPathPattern contextualPath,
16+
RestClientInfo restClientInfo,
17+
InputServiceMethod method,
18+
bool isAsync,
19+
ResourceOperationKind methodKind)
20+
: base(resource, contextualPath, restClientInfo, method, isAsync, methodName: isAsync ? "UpdateAsync" : "Update", description: GetDescription(resource, methodKind))
21+
{
22+
}
23+
24+
private static FormattableString? GetDescription(ResourceClientProvider resource, ResourceOperationKind methodKind)
25+
{
26+
// Only override description if this is a Create operation being used as Update
27+
return methodKind == ResourceOperationKind.Create ? FormattableStringFactory.Create("Update a {0}.", resource.ResourceName) : null;
28+
}
1629
}
1730
}

eng/packages/http-client-csharp-mgmt/generator/Azure.Generator.Management/src/Providers/ResourceClientProvider.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -437,10 +437,10 @@ protected override MethodProvider[] BuildMethods()
437437

438438
if (isUpdateOperation)
439439
{
440-
var updateAsyncMethodProvider = new UpdateOperationMethodProvider(this, _contextualPath, restClientInfo, method, true);
440+
var updateAsyncMethodProvider = new UpdateOperationMethodProvider(this, _contextualPath, restClientInfo, method, true, methodKind);
441441
operationMethods.Add(updateAsyncMethodProvider);
442442

443-
updateMethodProvider = new UpdateOperationMethodProvider(this, _contextualPath, restClientInfo, method, false);
443+
updateMethodProvider = new UpdateOperationMethodProvider(this, _contextualPath, restClientInfo, method, false, methodKind);
444444
operationMethods.Add(updateMethodProvider);
445445
}
446446
else

eng/packages/http-client-csharp-mgmt/generator/TestProjects/Local/Mgmt-TypeSpec/src/Generated/FooResource.cs

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)