Populate client description (#6117)

Fixes #6116
microsoft · Feb 24, 2025 · f90c2d7 · f90c2d7
1 parent f523b08
commit f90c2d7
Show file tree

Hide file tree

Showing 9 changed files with 23 additions and 7 deletions.
diff --git a/...csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/src/Providers/ClientProvider.cs b/...csharp/generator/Microsoft.TypeSpec.Generator.ClientModel/src/Providers/ClientProvider.cs
@@ -13,6 +13,7 @@
 using Microsoft.TypeSpec.Generator.Providers;
 using Microsoft.TypeSpec.Generator.Snippets;
 using Microsoft.TypeSpec.Generator.Statements;
+using Microsoft.TypeSpec.Generator.Utilities;
 using static Microsoft.TypeSpec.Generator.Snippets.Snippet;
 
 namespace Microsoft.TypeSpec.Generator.ClientModel.Providers
@@ -48,6 +49,8 @@ private record OAuth2Fields(FieldProvider AuthField, FieldProvider Authorization
 
         private Lazy<ParameterProvider?> ClientOptionsParameter { get; }
 
+        protected override FormattableString Description { get; }
+
         // for mocking
 #pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider declaring as nullable.
         protected ClientProvider()
@@ -63,6 +66,7 @@ public ClientProvider(InputClient inputClient)
             _publicCtorDescription = $"Initializes a new instance of {Name}.";
             ClientOptions = new Lazy<ClientOptionsProvider?>(() => _inputClient.Parent is null ? new ClientOptionsProvider(_inputClient, this) : null);
             ClientOptionsParameter = new Lazy<ParameterProvider?>(() => ClientOptions.Value != null ? ScmKnownParameters.ClientOptions(ClientOptions.Value.Type) : null);
+            Description = DocHelpers.GetFormattableDescription(_inputClient.Summary, _inputClient.Doc) ?? FormattableStringHelpers.Empty;
 
             var apiKey = _inputAuth?.ApiKey;
             var keyCredentialType = ScmCodeModelPlugin.Instance.TypeFactory.ClientPipelineApi.KeyCredentialType;

diff --git a/...soft.TypeSpec.Generator.ClientModel/test/Providers/ClientProviders/ClientProviderTests.cs b/...soft.TypeSpec.Generator.ClientModel/test/Providers/ClientProviders/ClientProviderTests.cs
@@ -803,6 +803,18 @@ public void NullClientProviderIsNotAddedToLibrary()
             Assert.IsEmpty(plugin.Object.OutputLibrary.TypeProviders.OfType<ClientProvider>());
         }
 
+        [TestCase]
+        public void ClientProviderSummaryIsPopulated()
+        {
+            var plugin = MockHelpers.LoadMockPlugin(
+                clients: () => [InputFactory.Client("test", clientNamespace: "test", doc: "client description")]);
+
+            var client = plugin.Object.OutputLibrary.TypeProviders.OfType<ClientProvider>().SingleOrDefault();
+            Assert.IsNotNull(client);
+
+            Assert.AreEqual("/// <summary> client description. </summary>\n", client!.XmlDocs.Summary!.ToDisplayString());
+        }
+
         private static InputClient GetEnumQueryParamClient()
             => InputFactory.Client(
                 TestClientName,

diff --git a/...iders/ClientProviders/TestData/ClientProviderSubClientTests/ServiceClientWithSubClient.cs b/...iders/ClientProviders/TestData/ClientProviderSubClientTests/ServiceClientWithSubClient.cs
@@ -6,7 +6,7 @@
 
 namespace Sample
 {
-    /// <summary></summary>
+    /// <summary> TestClient description. </summary>
     public partial class TestClient
     {
         /// <summary> Initializes a new instance of Animal. </summary>

diff --git a/.../ClientProviders/TestData/ClientProviderSubClientTests/SubClientWithMultipleSubClients.cs b/.../ClientProviders/TestData/ClientProviderSubClientTests/SubClientWithMultipleSubClients.cs
@@ -6,7 +6,7 @@
 
 namespace Sample
 {
-    /// <summary></summary>
+    /// <summary> AnimalClient description. </summary>
     public partial class Animal
     {
         /// <summary> Initializes a new instance of Dog. </summary>

diff --git a/...ers/ClientProviders/TestData/ClientProviderSubClientTests/SubClientWithSingleSubClient.cs b/...ers/ClientProviders/TestData/ClientProviderSubClientTests/SubClientWithSingleSubClient.cs
@@ -6,7 +6,7 @@
 
 namespace Sample
 {
-    /// <summary></summary>
+    /// <summary> DogClient description. </summary>
     public partial class Dog
     {
         /// <summary> Initializes a new instance of Husky. </summary>

diff --git a/...s/ClientProviders/TestData/ClientProviderTests/ValidateConstructorsWhenUnsupportedAuth.cs b/...s/ClientProviders/TestData/ClientProviderTests/ValidateConstructorsWhenUnsupportedAuth.cs
@@ -7,7 +7,7 @@
 
 namespace Sample
 {
-    /// <summary></summary>
+    /// <summary> TestClient description. </summary>
     public partial class TestClient
     {
         internal TestClient(global::System.Uri endpoint) : this(endpoint, new global::Sample.TestClientOptions())

diff --git a/...iders/ClientProviders/TestData/ClientProviderTests/ValidateQueryParamWriterDiff(False).cs b/...iders/ClientProviders/TestData/ClientProviderTests/ValidateQueryParamWriterDiff(False).cs
@@ -9,7 +9,7 @@
 
 namespace Sample
 {
-    /// <summary></summary>
+    /// <summary> TestClient description. </summary>
     public partial class TestClient
     {
         public virtual global::System.ClientModel.ClientResult Operation(global::Sample.Models.InputEnum queryParam, global::System.Threading.CancellationToken cancellationToken = default)

diff --git a/...viders/ClientProviders/TestData/ClientProviderTests/ValidateQueryParamWriterDiff(True).cs b/...viders/ClientProviders/TestData/ClientProviderTests/ValidateQueryParamWriterDiff(True).cs
@@ -10,7 +10,7 @@
 
 namespace Sample
 {
-    /// <summary></summary>
+    /// <summary> TestClient description. </summary>
     public partial class TestClient
     {
         public virtual async global::System.Threading.Tasks.Task<global::System.ClientModel.ClientResult> OperationAsync(global::Sample.Models.InputEnum queryParam, global::System.Threading.CancellationToken cancellationToken = default)

diff --git a/.../generator/TestProjects/Local/Unbranded-TypeSpec/src/Generated/UnbrandedTypeSpecClient.cs b/.../generator/TestProjects/Local/Unbranded-TypeSpec/src/Generated/UnbrandedTypeSpecClient.cs
@@ -13,7 +13,7 @@
 
 namespace UnbrandedTypeSpec
 {
-    /// <summary></summary>
+    /// <summary> This is a sample typespec project. </summary>
     public partial class UnbrandedTypeSpecClient
     {
         private readonly Uri _endpoint;