Merge pull request #366 from VitaliyKurokhtin/vvk/component-headers

Supporting all header fields inside components/headers

Author: PerthCharern

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

@@ -33,6 +33,12 @@ internal static partial class OpenApiV3Deserializer
                     o.Deprecated = bool.Parse(n.GetScalarValue());
                 }
             },
+            {
+                "allowEmptyValue", (o, n) =>
+                {
+                    o.AllowEmptyValue = bool.Parse(n.GetScalarValue());
+                }
+            },
             {
                 "allowReserved", (o, n) =>
                 {
@@ -45,12 +51,30 @@ internal static partial class OpenApiV3Deserializer
                     o.Style = n.GetScalarValue().GetEnumFromDisplayName<ParameterStyle>();
                 }
             },
+            {
+                "explode", (o, n) =>
+                {
+                    o.Explode = bool.Parse(n.GetScalarValue());
+                }
+            },
             {
                 "schema", (o, n) =>
                 {
                     o.Schema = LoadSchema(n);
                 }
-            }
+            },
+            {
+                "examples", (o, n) =>
+                {
+                    o.Examples = n.CreateMap(LoadExample);
+                }
+            },
+            {
+                "example", (o, n) =>
+                {
+                    o.Example = n.CreateAny();
+                }
+            },
         };
 
         private static readonly PatternFieldMap<OpenApiHeader> _headerPatternFields = new PatternFieldMap<OpenApiHeader>

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

@@ -118,6 +118,9 @@
       <EmbeddedResource Include="V3Tests\Samples\OpenApiDocument\minimalDocument.yaml">
         <CopyToOutputDirectory>Never</CopyToOutputDirectory>
       </EmbeddedResource>
+      <EmbeddedResource Include="V3Tests\Samples\OpenApiDocument\apiWithFullHeaderComponent.yaml">
+        <CopyToOutputDirectory>Never</CopyToOutputDirectory>
+      </EmbeddedResource>
       <EmbeddedResource Include="V3Tests\Samples\OpenApiDocument\petStore.yaml">
         <CopyToOutputDirectory>Never</CopyToOutputDirectory>
       </EmbeddedResource>

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;
@@ -1204,5 +1205,76 @@ public void GlobalSecurityRequirementShouldReferenceSecurityScheme()
                 Assert.Same(securityRequirement.Keys.First(), openApiDoc.Components.SecuritySchemes.First().Value);
             }
         }
+
+        [Fact]
+        public void HeaderParameterShouldAllowExample()
+        {
+            using (var stream = Resources.GetStream(Path.Combine(SampleFolderPath, "apiWithFullHeaderComponent.yaml")))
+            {
+                var openApiDoc = new OpenApiStreamReader().Read(stream, out var diagnostic);
+
+                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

@@ -0,0 +1,34 @@
+openapi: '3.0.0'
+info:
+  version: '1.0.0'
+  title: Header components
+components:
+  headers:
+    example-header:
+      description: Test header with example
+      required: true
+      deprecated: true
+      allowEmptyValue: true
+      allowReserved: true
+      style: simple
+      explode: true
+      example: "99391c7e-ad88-49ec-a2ad-99ddcb1f7721"
+      schema:
+        type: string
+        format: uuid
+    examples-header:
+      description: Test header with example
+      required: true
+      deprecated: true
+      allowEmptyValue: true
+      allowReserved: true
+      style: simple
+      explode: true
+      examples:
+        uuid1: 
+            value: "99391c7e-ad88-49ec-a2ad-99ddcb1f7721"
+        uuid2:
+            value: "99391c7e-ad88-49ec-a2ad-99ddcb1f7721"
+      schema:
+        type: string
+        format: uuid