Fix schema builder so it reads schema descriptions (#3666)

graphql-dotnet · Jul 23, 2023 · ad9286e · ad9286e
1 parent 62f38bf
commit ad9286e
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 1 deletion.
diff --git a/src/GraphQL.Tests/Utilities/SchemaBuilderTests.cs b/src/GraphQL.Tests/Utilities/SchemaBuilderTests.cs
@@ -6,6 +6,49 @@ namespace GraphQL.Tests.Utilities;
 
 public class SchemaBuilderTests
 {
+    [Theory]
+    [InlineData(false)]
+    [InlineData(true)]
+    public void should_read_schema_description(bool ignoreComments)
+    {
+        const string definitions = """
+            #test
+            "Sample schema"
+            schema {
+              query: Query
+            }
+            "Sample query"
+            type Query {
+              id: String
+            }
+            """;
+
+        var schema = Schema.For(definitions, c => c.IgnoreComments = ignoreComments);
+        schema.Initialize();
+
+        schema.Description.ShouldBe("Sample schema");
+    }
+
+    [Fact]
+    public void should_read_schema_description_from_comments()
+    {
+        const string definitions = """
+            #test
+            schema {
+              query: Query
+            }
+            "Sample query"
+            type Query {
+              id: String
+            }
+            """;
+
+        var schema = Schema.For(definitions, c => c.IgnoreComments = false);
+        schema.Initialize();
+
+        schema.Description.ShouldBe("test");
+    }
+
     [Fact]
     public void should_set_query_by_name()
     {

diff --git a/src/GraphQL/Utilities/SchemaBuilder.cs b/src/GraphQL/Utilities/SchemaBuilder.cs
@@ -167,7 +167,7 @@ private Schema BuildSchemaFrom(GraphQLDocument document)
 
             if (_schemaDef != null)
             {
-                schema.Description = _schemaDef.MergeComments();
+                schema.Description = _schemaDef.Description?.Value.ToString() ?? _schemaDef.MergeComments();
 
                 foreach (var operationTypeDef in _schemaDef.OperationTypes!)
                 {