Merge pull request #2280 from microsoft/mw/update-discriminator-mappings

Michael-Wamae · web-flow · commit b4877f674ad1 · 2025-04-01T09:12:14.000-04:00
feat: discriminator mappings now use schema references
diff --git a/src/Microsoft.OpenApi/Models/OpenApiDiscriminator.cs b/src/Microsoft.OpenApi/Models/OpenApiDiscriminator.cs
@@ -3,6 +3,7 @@
 
 using System.Collections.Generic;
 using Microsoft.OpenApi.Interfaces;
+using Microsoft.OpenApi.Models.References;
 using Microsoft.OpenApi.Writers;
 
 namespace Microsoft.OpenApi.Models
@@ -20,7 +21,7 @@ public class OpenApiDiscriminator : IOpenApiSerializable, IOpenApiExtensible
         /// <summary>
         /// An object to hold mappings between payload values and schema names or references.
         /// </summary>
-        public IDictionary<string, string>? Mapping { get; set; } = new Dictionary<string, string>();
+        public IDictionary<string, OpenApiSchemaReference>? Mapping { get; set; } = new Dictionary<string, OpenApiSchemaReference>();
 
         /// <summary>
         /// This object MAY be extended with Specification Extensions.
@@ -38,7 +39,7 @@ public OpenApiDiscriminator() { }
         public OpenApiDiscriminator(OpenApiDiscriminator discriminator)
         {
             PropertyName = discriminator?.PropertyName ?? PropertyName;
-            Mapping = discriminator?.Mapping != null ? new Dictionary<string, string>(discriminator.Mapping) : null;
+            Mapping = discriminator?.Mapping != null ? new Dictionary<string, OpenApiSchemaReference>(discriminator.Mapping) : null;
             Extensions = discriminator?.Extensions != null ? new Dictionary<string, IOpenApiExtension>(discriminator.Extensions) : null;
         }
 
@@ -80,7 +81,13 @@ private void SerializeInternal(IOpenApiWriter writer)
             writer.WriteProperty(OpenApiConstants.PropertyName, PropertyName);
 
             // mapping
-            writer.WriteOptionalMap(OpenApiConstants.Mapping, Mapping, (w, s) => w.WriteValue(s));
+            writer.WriteOptionalMap(OpenApiConstants.Mapping, Mapping, (w, s) =>
+            {
+                if (!string.IsNullOrEmpty(s.Reference.ReferenceV3) && s.Reference.ReferenceV3 is not null)
+                {
+                    w.WriteValue(s.Reference.ReferenceV3);
+                }
+            });
         }
 
         /// <summary>
diff --git a/src/Microsoft.OpenApi/Reader/V3/OpenApiDiscriminatorDeserializer.cs b/src/Microsoft.OpenApi/Reader/V3/OpenApiDiscriminatorDeserializer.cs
@@ -1,8 +1,10 @@
 ﻿// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
+using System;
 using System.Linq;
 using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Models.References;
 using Microsoft.OpenApi.Reader.ParseNodes;
 
 namespace Microsoft.OpenApi.Reader.V3
@@ -22,7 +24,7 @@ internal static partial class OpenApiV3Deserializer
                 },
                 {
                     "mapping",
-                    (o, n, _) => o.Mapping = n.CreateSimpleMap(LoadString).Where(kv => kv.Value is not null).ToDictionary(kv => kv.Key, kv => kv.Value!)
+                    (o, n, doc) => o.Mapping = n.CreateSimpleMap((node) => LoadMapping(node, doc))
                 }
             };
 
@@ -40,5 +42,11 @@ public static OpenApiDiscriminator LoadDiscriminator(ParseNode node, OpenApiDocu
 
             return discriminator;
         }
+        public static OpenApiSchemaReference LoadMapping(ParseNode node, OpenApiDocument hostDocument)
+        {
+            var pointer = node.GetScalarValue() ?? throw new InvalidOperationException("Could not get a pointer reference");
+            var reference = GetReferenceIdAndExternalResource(pointer);
+            return new OpenApiSchemaReference(reference.Item1, hostDocument, reference.Item2);
+        }
     }
 }
diff --git a/src/Microsoft.OpenApi/Reader/V3/OpenApiV3VersionService.cs b/src/Microsoft.OpenApi/Reader/V3/OpenApiV3VersionService.cs
@@ -5,11 +5,9 @@
 using System.Collections.Generic;
 using System.Linq;
 using Microsoft.OpenApi.Any;
-using Microsoft.OpenApi.Exceptions;
-using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Models;
-using Microsoft.OpenApi.Properties;
+using Microsoft.OpenApi.Models.References;
 using Microsoft.OpenApi.Reader.ParseNodes;
 
 namespace Microsoft.OpenApi.Reader.V3
@@ -62,7 +60,8 @@ public OpenApiV3VersionService(OpenApiDiagnostic diagnostic)
             [typeof(OpenApiServer)] = OpenApiV3Deserializer.LoadServer,
             [typeof(OpenApiServerVariable)] = OpenApiV3Deserializer.LoadServerVariable,
             [typeof(OpenApiTag)] = OpenApiV3Deserializer.LoadTag,
-            [typeof(OpenApiXml)] = OpenApiV3Deserializer.LoadXml
+            [typeof(OpenApiXml)] = OpenApiV3Deserializer.LoadXml,
+            [typeof(OpenApiSchemaReference)] = OpenApiV3Deserializer.LoadMapping
         };
 
         public OpenApiDocument LoadDocument(RootNode rootNode)
diff --git a/src/Microsoft.OpenApi/Reader/V31/OpenApiDiscriminatorDeserializer.cs b/src/Microsoft.OpenApi/Reader/V31/OpenApiDiscriminatorDeserializer.cs
@@ -2,6 +2,7 @@
 using System.Linq;
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Models.References;
 using Microsoft.OpenApi.Reader.ParseNodes;
 
 namespace Microsoft.OpenApi.Reader.V31
@@ -22,9 +23,9 @@ internal static partial class OpenApiV31Deserializer
                     }
                 },
                 {
-                    "mapping", (o, n, _) =>
+                    "mapping", (o, n, doc) =>
                     {
-                        o.Mapping = n.CreateSimpleMap(LoadString).Where(kv => kv.Value is not null).ToDictionary(kv => kv.Key, kv => kv.Value!);
+                        o.Mapping = n.CreateSimpleMap((node) => LoadMapping(node, doc));
                     }
                 }
             };
@@ -47,5 +48,12 @@ public static OpenApiDiscriminator LoadDiscriminator(ParseNode node, OpenApiDocu
 
             return discriminator;
         }
+
+        public static OpenApiSchemaReference LoadMapping(ParseNode node, OpenApiDocument hostDocument)
+        {
+            var pointer = node.GetScalarValue() ?? throw new InvalidOperationException("Could not get a pointer reference");
+            var reference = GetReferenceIdAndExternalResource(pointer);
+            return new OpenApiSchemaReference(reference.Item1, hostDocument, reference.Item2);
+        }
     }
 }
diff --git a/src/Microsoft.OpenApi/Reader/V31/OpenApiV31VersionService.cs b/src/Microsoft.OpenApi/Reader/V31/OpenApiV31VersionService.cs
@@ -5,11 +5,9 @@
 using System.Collections.Generic;
 using System.Linq;
 using Microsoft.OpenApi.Any;
-using Microsoft.OpenApi.Exceptions;
-using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Models;
-using Microsoft.OpenApi.Properties;
+using Microsoft.OpenApi.Models.References;
 using Microsoft.OpenApi.Reader.ParseNodes;
 using Microsoft.OpenApi.Reader.V3;
 
@@ -61,7 +59,8 @@ public OpenApiV31VersionService(OpenApiDiagnostic diagnostic)
             [typeof(OpenApiServer)] = OpenApiV31Deserializer.LoadServer,
             [typeof(OpenApiServerVariable)] = OpenApiV31Deserializer.LoadServerVariable,
             [typeof(OpenApiTag)] = OpenApiV31Deserializer.LoadTag,
-            [typeof(OpenApiXml)] = OpenApiV31Deserializer.LoadXml
+            [typeof(OpenApiXml)] = OpenApiV31Deserializer.LoadXml,
+            [typeof(OpenApiSchemaReference)] = OpenApiV31Deserializer.LoadMapping
         };
 
         public OpenApiDocument LoadDocument(RootNode rootNode)
diff --git a/test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiDiscriminatorTests.cs b/test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiDiscriminatorTests.cs
@@ -1,9 +1,11 @@
 ﻿// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
+using System;
 using System.IO;
 using System.Threading.Tasks;
 using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Models.References;
 using Microsoft.OpenApi.Reader;
 using Xunit;
 
@@ -25,19 +27,21 @@ public async Task ParseBasicDiscriminatorShouldSucceed()
             memoryStream.Position = 0;
 
             // Act
-            var discriminator = OpenApiModelFactory.Load<OpenApiDiscriminator>(memoryStream, OpenApiSpecVersion.OpenApi3_0, OpenApiConstants.Yaml, new(), out var diagnostic, SettingsFixture.ReaderSettings);
+            var openApiDocument = new OpenApiDocument();
+            var discriminator = OpenApiModelFactory.Load<OpenApiDiscriminator>(memoryStream, OpenApiSpecVersion.OpenApi3_0, OpenApiConstants.Yaml, openApiDocument, out var diagnostic, SettingsFixture.ReaderSettings);
 
             // Assert
             Assert.Equivalent(
-                new OpenApiDiscriminator
-                {
-                    PropertyName = "pet_type",
-                    Mapping =
+               new OpenApiDiscriminator
+               {
+                   PropertyName = "pet_type",
+                   Mapping =
                     {
-                            ["puppy"] = "#/components/schemas/Dog",
-                            ["kitten"] = "Cat"
+                            ["puppy"] = new OpenApiSchemaReference("Dog", openApiDocument),
+                            ["kitten"] = new OpenApiSchemaReference("Cat" , openApiDocument, "https://gigantic-server.com/schemas/animals.json"),
+                            ["monster"] = new OpenApiSchemaReference("schema.json" , openApiDocument, "https://gigantic-server.com/schemas/Monster/schema.json")
                     }
-                }, discriminator);
+               }, discriminator);
         }
     }
 }
diff --git a/test/Microsoft.OpenApi.Readers.Tests/V3Tests/Samples/OpenApiDiscriminator/basicDiscriminator.yaml b/test/Microsoft.OpenApi.Readers.Tests/V3Tests/Samples/OpenApiDiscriminator/basicDiscriminator.yaml
@@ -1,4 +1,5 @@
 ﻿propertyName: pet_type
 mapping:
     puppy: '#/components/schemas/Dog'
-    kitten: Cat
+    kitten: https://gigantic-server.com/schemas/animals.json#/components/schemas/Cat
+    monster: https://gigantic-server.com/schemas/Monster/schema.json
diff --git a/test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt b/test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt
@@ -699,7 +699,7 @@ namespace Microsoft.OpenApi.Models
         public OpenApiDiscriminator() { }
         public OpenApiDiscriminator(Microsoft.OpenApi.Models.OpenApiDiscriminator discriminator) { }
         public System.Collections.Generic.IDictionary<string, Microsoft.OpenApi.Interfaces.IOpenApiExtension>? Extensions { get; set; }
-        public System.Collections.Generic.IDictionary<string, string>? Mapping { get; set; }
+        public System.Collections.Generic.IDictionary<string, Microsoft.OpenApi.Models.References.OpenApiSchemaReference>? Mapping { get; set; }
         public string? PropertyName { get; set; }
         public void SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter writer) { }
         public void SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter writer) { }

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,10 @@`
`1`	`1`	`// Copyright (c) Microsoft Corporation. All rights reserved.`
`2`	`2`	`// Licensed under the MIT license.`
`3`	`3`
	`4`	`+using System;`
`4`	`5`	`using System.Linq;`
`5`	`6`	`using Microsoft.OpenApi.Models;`
	`7`	`+using Microsoft.OpenApi.Models.References;`
`6`	`8`	`using Microsoft.OpenApi.Reader.ParseNodes;`
`7`	`9`
`8`	`10`	`namespace Microsoft.OpenApi.Reader.V3`
`@@ -22,7 +24,7 @@ internal static partial class OpenApiV3Deserializer`
`22`	`24`	`},`
`23`	`25`	`{`
`24`	`26`	`"mapping",`
`25`		`- (o, n, _) => o.Mapping = n.CreateSimpleMap(LoadString).Where(kv => kv.Value is not null).ToDictionary(kv => kv.Key, kv => kv.Value!)`
	`27`	`+ (o, n, doc) => o.Mapping = n.CreateSimpleMap((node) => LoadMapping(node, doc))`
`26`	`28`	`}`
`27`	`29`	`};`
`28`	`30`
`@@ -40,5 +42,11 @@ public static OpenApiDiscriminator LoadDiscriminator(ParseNode node, OpenApiDocu`
`40`	`42`
`41`	`43`	`return discriminator;`
`42`	`44`	`}`
	`45`	`+ public static OpenApiSchemaReference LoadMapping(ParseNode node, OpenApiDocument hostDocument)`
	`46`	`+ {`
	`47`	`+ var pointer = node.GetScalarValue() ?? throw new InvalidOperationException("Could not get a pointer reference");`
	`48`	`+ var reference = GetReferenceIdAndExternalResource(pointer);`
	`49`	`+ return new OpenApiSchemaReference(reference.Item1, hostDocument, reference.Item2);`
	`50`	`+ }`
`43`	`51`	`}`
`44`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`	`using System.Linq;`
`3`	`3`	`using Microsoft.OpenApi.Extensions;`
`4`	`4`	`using Microsoft.OpenApi.Models;`
	`5`	`+using Microsoft.OpenApi.Models.References;`
`5`	`6`	`using Microsoft.OpenApi.Reader.ParseNodes;`
`6`	`7`
`7`	`8`	`namespace Microsoft.OpenApi.Reader.V31`
`@@ -22,9 +23,9 @@ internal static partial class OpenApiV31Deserializer`
`22`	`23`	`}`
`23`	`24`	`},`
`24`	`25`	`{`
`25`		`- "mapping", (o, n, _) =>`
	`26`	`+ "mapping", (o, n, doc) =>`
`26`	`27`	`{`
`27`		`- o.Mapping = n.CreateSimpleMap(LoadString).Where(kv => kv.Value is not null).ToDictionary(kv => kv.Key, kv => kv.Value!);`
	`28`	`+ o.Mapping = n.CreateSimpleMap((node) => LoadMapping(node, doc));`
`28`	`29`	`}`
`29`	`30`	`}`
`30`	`31`	`};`
`@@ -47,5 +48,12 @@ public static OpenApiDiscriminator LoadDiscriminator(ParseNode node, OpenApiDocu`
`47`	`48`
`48`	`49`	`return discriminator;`
`49`	`50`	`}`
	`51`	`+`
	`52`	`+ public static OpenApiSchemaReference LoadMapping(ParseNode node, OpenApiDocument hostDocument)`
	`53`	`+ {`
	`54`	`+ var pointer = node.GetScalarValue() ?? throw new InvalidOperationException("Could not get a pointer reference");`
	`55`	`+ var reference = GetReferenceIdAndExternalResource(pointer);`
	`56`	`+ return new OpenApiSchemaReference(reference.Item1, hostDocument, reference.Item2);`
	`57`	`+ }`
`50`	`58`	`}`
`51`	`59`	`}`