Header test improved

Author: VitaliyKurokhtin

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

@@ -8,6 +8,7 @@
 using System.Linq;
 using System.Threading;
 using FluentAssertions;
+using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Validations;
 using Microsoft.OpenApi.Validations.Rules;
@@ -1211,7 +1212,68 @@ public void HeaderParameterShouldAllowExample()
             using (var stream = Resources.GetStream(Path.Combine(SampleFolderPath, "apiWithFullHeaderComponent.yaml")))
             {
                 var openApiDoc = new OpenApiStreamReader().Read(stream, out var diagnostic);
-                Assert.Equal(0, diagnostic.Errors.Count);
+
+                var exampleHeader = openApiDoc.Components?.Headers?["example-header"];
+                Assert.NotNull(exampleHeader);
+                exampleHeader.ShouldBeEquivalentTo(
+                    new OpenApiHeader()
+                    {
+                        Description = "Test header with example",
+                        Required = true,
+                        Deprecated = true,
+                        AllowEmptyValue = true,
+                        AllowReserved = true,
+                        Style = ParameterStyle.Simple,
+                        Explode = true,
+                        Example = new OpenApiString("99391c7e-ad88-49ec-a2ad-99ddcb1f7721"),
+                        Schema = new OpenApiSchema()
+                        {
+                            Type = "string",
+                            Format = "uuid"
+                        },
+                        Reference = new OpenApiReference()
+                        {
+                            Type = ReferenceType.Header,
+                            Id = "example-header"
+                        }
+                    });
+
+                var examplesHeader = openApiDoc.Components?.Headers?["examples-header"];
+                Assert.NotNull(examplesHeader);
+                examplesHeader.ShouldBeEquivalentTo(
+                    new OpenApiHeader()
+                    {
+                        Description = "Test header with example",
+                        Required = true,
+                        Deprecated = true,
+                        AllowEmptyValue = true,
+                        AllowReserved = true,
+                        Style = ParameterStyle.Simple,
+                        Explode = true,
+                        Examples = new Dictionary<string, OpenApiExample>()
+                        {
+                            { "uuid1", new OpenApiExample()
+                                {
+                                    Value = new OpenApiString("99391c7e-ad88-49ec-a2ad-99ddcb1f7721")
+                                }
+                            },
+                            { "uuid2", new OpenApiExample()
+                                {
+                                    Value = new OpenApiString("99391c7e-ad88-49ec-a2ad-99ddcb1f7721")
+                                }
+                            }
+                        },
+                        Schema = new OpenApiSchema()
+                        {
+                            Type = "string",
+                            Format = "uuid"
+                        },
+                        Reference = new OpenApiReference()
+                        {
+                            Type = ReferenceType.Header,
+                            Id = "examples-header"
+                        }
+                    });
             }
         }
     }

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

@@ -2,39 +2,33 @@ openapi: '3.0.0'
 info:
   version: '1.0.0'
   title: Header components
-paths:
-  /:
-    get:
-      responses:
-        '200':
-          description: sample response
-          headers:
-            $ref: "#/components/headers/X-Request-ID"
 components:
   headers:
     example-header:
       description: Test header with example
       required: true
-      deprecated: false
-      allowEmptyValue: false
+      deprecated: true
+      allowEmptyValue: true
       allowReserved: true
       style: simple
-      explode: false
+      explode: true
       example: "99391c7e-ad88-49ec-a2ad-99ddcb1f7721"
       schema:
         type: string
         format: uuid
     examples-header:
       description: Test header with example
       required: true
-      deprecated: false
-      allowEmptyValue: false
+      deprecated: true
+      allowEmptyValue: true
       allowReserved: true
       style: simple
-      explode: false
+      explode: true
       examples:
-        uuid1: "99391c7e-ad88-49ec-a2ad-99ddcb1f7721"
-        uuid2: "99391c7e-ad88-49ec-a2ad-99ddcb1f7721"
+        uuid1: 
+            value: "99391c7e-ad88-49ec-a2ad-99ddcb1f7721"
+        uuid2:
+            value: "99391c7e-ad88-49ec-a2ad-99ddcb1f7721"
       schema:
         type: string
         format: uuid