Add test

Author: MaggieKimani1

test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj

@@ -128,6 +128,9 @@
       <EmbeddedResource Include="V3Tests\Samples\OpenApiDocument\documentWithReusablePaths.yaml">
         <CopyToOutputDirectory>Never</CopyToOutputDirectory>
       </EmbeddedResource>
+      <EmbeddedResource Include="V3Tests\Samples\OpenApiDocument\documentWithSummaryAndDescriptionInReference.yaml">
+        <CopyToOutputDirectory>Never</CopyToOutputDirectory>
+      </EmbeddedResource>
       <EmbeddedResource Include="V3Tests\Samples\OpenApiDiscriminator\basicDiscriminator.yaml">
         <CopyToOutputDirectory>Never</CopyToOutputDirectory>
       </EmbeddedResource>

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

@@ -16,6 +16,8 @@
 using Microsoft.OpenApi.Writers;
 using Xunit;
 using Xunit.Abstractions;
+using Xunit.Sdk;
+using static System.Net.Mime.MediaTypeNames;
 
 namespace Microsoft.OpenApi.Readers.Tests.V3Tests
 {
@@ -1777,5 +1779,22 @@ public void ParseDocumentsWithReusablePathItemInWebhooksSucceeds()
     new OpenApiDiagnostic() { SpecificationVersion = OpenApiSpecVersion.OpenApi3_0 });
 
         }
+
+        [Fact]
+        public void ParseDocumentWithDescriptionInDollarRefsShouldSucceed()
+        {
+            // Arrange
+            using var stream = Resources.GetStream(Path.Combine(SampleFolderPath, "documentWithSummaryAndDescriptionInReference.yaml"));
+
+            // Act
+            var actual = new OpenApiStreamReader().Read(stream, out var diagnostic);
+            var schema = actual.Paths["/pets"].Operations[OperationType.Get].Responses["200"].Content["application/json"].Schema;
+            var header = actual.Components.Responses["Test"].Headers["X-Test"];
+
+            // Assert
+            Assert.True(header.Description == "A referenced X-Test header"); /*response header #ref's description overrides the header's description*/
+            Assert.True(schema.UnresolvedReference == false && schema.Type == "object"); /*schema reference is resolved*/
+            Assert.Equal("A pet in a petstore", schema.Description); /*The reference object's description overrides that of the referenced component*/
+        }
     }
 }

test/Microsoft.OpenApi.Readers.Tests/V3Tests/Samples/OpenApiDocument/documentWithSummaryAndDescriptionInReference.yaml

@@ -0,0 +1,46 @@
+openapi: '3.1.0'
+info:
+  version: '1.0.0'
+  title: Swagger Petstore (Simple)
+paths:
+  /pets:
+    get:
+      description: Returns all pets from the system that the user has access to
+      responses:
+        '200':
+          description: pet response
+          content:
+            application/json:
+                schema:
+                  "$ref": '#/components/schemas/pet'
+                  summary: A pet
+                  description: A pet in a petstore
+components:
+  headers:
+    X-Test:
+      description: Test
+      schema:
+        type: string
+  responses:
+    Test:
+      description: Test Repsonse
+      headers:
+        X-Test:
+          $ref: '#/components/headers/X-Test'
+          summary: X-Test header
+          description: A referenced X-Test header
+  schemas:
+    pet:
+      description: A referenced pet in a petstore
+      type: object
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          format: int64
+          name:
+            type: string
+            tag:
+              type: string