Merge pull request #1039 from microsoft/mk/add-summary-to-info-object

Adds a summary property in the info object

Author: MaggieKimani1

src/Microsoft.OpenApi.Readers/V2/OpenApiV2Deserializer.cs

@@ -113,8 +113,6 @@ private static void ProcessAnyMapFields<T, U>(
             {
                 try
                 {
-                    var newProperty = new List<IOpenApiAny>();
-
                     mapNode.Context.StartObject(anyMapFieldName);
 
                     foreach (var propertyMapElement in anyMapFieldMap[anyMapFieldName].PropertyMapGetter(domainObject))

src/Microsoft.OpenApi.Readers/V3/OpenApiInfoDeserializer.cs

@@ -29,6 +29,12 @@ internal static partial class OpenApiV3Deserializer
                     o.Version = n.GetScalarValue();
                 }
             },
+            {
+                "summary", (o, n) =>
+                {
+                    o.Summary = n.GetScalarValue();
+                }
+            },
             {
                 "description", (o, n) =>
                 {
@@ -63,10 +69,7 @@ internal static partial class OpenApiV3Deserializer
         public static OpenApiInfo LoadInfo(ParseNode node)
         {
             var mapNode = node.CheckMapNode("Info");
-
             var info = new OpenApiInfo();
-            var required = new List<string> { "title", "version" };
-
             ParseMap(mapNode, info, InfoFixedFields, InfoPatternFields);
 
             return info;

src/Microsoft.OpenApi.Readers/V3/OpenApiResponseDeserializer.cs

@@ -58,7 +58,6 @@ public static OpenApiResponse LoadResponse(ParseNode node)
                 return mapNode.GetReferencedObject<OpenApiResponse>(ReferenceType.Response, pointer);
             }
 
-            var requiredFields = new List<string> { "description" };
             var response = new OpenApiResponse();
             ParseMap(mapNode, response, _responseFixedFields, _responsePatternFields);
 

src/Microsoft.OpenApi.Readers/V3/OpenApiV3Deserializer.cs

@@ -108,9 +108,7 @@ private static void ProcessAnyMapFields<T, U>(
             foreach (var anyMapFieldName in anyMapFieldMap.Keys.ToList())
             {
                 try
-                {
-                    var newProperty = new List<IOpenApiAny>();
-
+                {                   
                     mapNode.Context.StartObject(anyMapFieldName);
 
                     foreach (var propertyMapElement in anyMapFieldMap[anyMapFieldName].PropertyMapGetter(domainObject))

src/Microsoft.OpenApi/Models/OpenApiInfo.cs

@@ -3,7 +3,6 @@
 
 using System;
 using System.Collections.Generic;
-using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Writers;
 
@@ -19,11 +18,16 @@ public class OpenApiInfo : IOpenApiSerializable, IOpenApiExtensible
         /// </summary>
         public string Title { get; set; }
 
+        /// <summary>
+        /// A short summary of the API.
+        /// </summary>
+        public string Summary { get; set; }
+        
         /// <summary>
         /// A short description of the application.
         /// </summary>
         public string Description { get; set; }
-
+        
         /// <summary>
         /// REQUIRED. The version of the OpenAPI document.
         /// </summary>
@@ -60,6 +64,7 @@ public OpenApiInfo() {}
         public OpenApiInfo(OpenApiInfo info)
         {
             Title = info?.Title ?? Title;
+            Summary = info?.Summary ?? Summary;
             Description = info?.Description ?? Description;
             Version = info?.Version ?? Version;
             TermsOfService = info?.TermsOfService ?? TermsOfService;
@@ -83,6 +88,9 @@ public void SerializeAsV3(IOpenApiWriter writer)
             // title
             writer.WriteProperty(OpenApiConstants.Title, Title);
 
+            // summary
+            writer.WriteProperty(OpenApiConstants.Summary, Summary);
+            
             // description
             writer.WriteProperty(OpenApiConstants.Description, Description);
 

test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiInfoTests.cs

@@ -41,6 +41,7 @@ public void ParseAdvancedInfoShouldSucceed()
                     new OpenApiInfo
                     {
                         Title = "Advanced Info",
+                        Summary = "Sample Summary",
                         Description = "Sample Description",
                         Version = "1.0.0",
                         TermsOfService = new Uri("http://example.org/termsOfService"),
@@ -101,6 +102,7 @@ public void ParseBasicInfoShouldSucceed()
                     new OpenApiInfo
                     {
                         Title = "Basic Info",
+                        Summary = "Sample Summary",
                         Description = "Sample Description",
                         Version = "1.0.1",
                         TermsOfService = new Uri("http://swagger.io/terms/"),

test/Microsoft.OpenApi.Readers.Tests/V3Tests/Samples/OpenApiInfo/advancedInfo.yaml

@@ -1,5 +1,6 @@
 title: Advanced Info
 version: 1.0.0
+summary: Sample Summary
 description: Sample Description
 termsOfService: http://example.org/termsOfService
 contact: 

test/Microsoft.OpenApi.Readers.Tests/V3Tests/Samples/OpenApiInfo/basicInfo.yaml

@@ -1,5 +1,6 @@
 {
   "title": "Basic Info",
+  "summary": "Sample Summary",
   "description": "Sample Description",
   "termsOfService": "http://swagger.io/terms/",
   "contact": {

test/Microsoft.OpenApi.Tests/Models/OpenApiInfoTests.cs

@@ -8,6 +8,7 @@
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Models;
+using SharpYaml;
 using Xunit;
 
 namespace Microsoft.OpenApi.Tests.Models
@@ -29,6 +30,14 @@ public class OpenApiInfoTests
             }
         };
 
+        public static OpenApiInfo InfoWithSummary = new()
+        {
+            Title = "Sample Pet Store App",
+            Summary = "This is a sample server for a pet store.",
+            Description = "This is a sample server for a pet store.",
+            Version = "1.1.1",
+        };
+
         public static OpenApiInfo BasicInfo = new OpenApiInfo
         {
             Title = "Sample Pet Store App",
@@ -101,6 +110,7 @@ public static IEnumerable<object[]> AdvanceInfoJsonExpect()
                     specVersion,
                     @"{
   ""title"": ""Sample Pet Store App"",
+  ""summary"": ""This is a sample server for a pet store."",
   ""description"": ""This is a sample server for a pet store."",
   ""termsOfService"": ""http://example.com/terms/"",
   ""contact"": {
@@ -195,5 +205,43 @@ public void InfoVersionShouldAcceptDateStyledAsVersions()
             expected = expected.MakeLineBreaksEnvironmentNeutral();
             actual.Should().Be(expected);
         }
+
+        [Fact]
+        public void SerializeInfoObjectWithSummaryAsV3YamlWorks()
+        {
+            // Arrange
+            var expected = @"title: Sample Pet Store App
+summary: This is a sample server for a pet store.
+description: This is a sample server for a pet store.
+version: '1.1.1'";
+
+            // Act
+            var actual = InfoWithSummary.SerializeAsYaml(OpenApiSpecVersion.OpenApi3_0);
+
+            // Assert
+            actual = actual.MakeLineBreaksEnvironmentNeutral();
+            expected = expected.MakeLineBreaksEnvironmentNeutral();
+            Assert.Equal(expected, actual);
+        }
+
+        [Fact]
+        public void SerializeInfoObjectWithSummaryAsV3JsonWorks()
+        {
+            // Arrange
+            var expected = @"{
+  ""title"": ""Sample Pet Store App"",
+  ""summary"": ""This is a sample server for a pet store."",
+  ""description"": ""This is a sample server for a pet store."",
+  ""version"": ""1.1.1""
+}";
+            
+            // Act
+            var actual = InfoWithSummary.SerializeAsJson(OpenApiSpecVersion.OpenApi3_0);
+
+            // Assert
+            actual = actual.MakeLineBreaksEnvironmentNeutral();
+            expected = expected.MakeLineBreaksEnvironmentNeutral();
+            Assert.Equal(expected, actual);
+        }
     }
 }