diff --git a/eng/Versions.props b/eng/Versions.props
index 7fa6c5c6c32b..717c92dbbebe 100644
--- a/eng/Versions.props
+++ b/eng/Versions.props
@@ -335,8 +335,8 @@
$(XunitVersion)
2.8.2
5.2.2
- 1.6.17
- 1.6.17
+ 2.0.0-preview2
+ 2.0.0-preview2
6.0.322601
1.10.93
diff --git a/eng/testing/linker/project.csproj.template b/eng/testing/linker/project.csproj.template
index ea368a6caa54..d78b5bfc991e 100644
--- a/eng/testing/linker/project.csproj.template
+++ b/eng/testing/linker/project.csproj.template
@@ -16,6 +16,8 @@
$(InterceptorsPreviewNamespaces);Microsoft.AspNetCore.Http.Generated
false
+
+ $(NoWarn);IL2104;IL3053
{AdditionalProperties}
@@ -27,4 +29,19 @@
{AdditionalProjectReferences}
+
+
+
+
+
+
+
+ true
+ true
+
+
+
+
diff --git a/src/OpenApi/perf/Microbenchmarks/OpenApiSchemaComparerBenchmark.cs b/src/OpenApi/perf/Microbenchmarks/OpenApiSchemaComparerBenchmark.cs
deleted file mode 100644
index 64bf0ce2736a..000000000000
--- a/src/OpenApi/perf/Microbenchmarks/OpenApiSchemaComparerBenchmark.cs
+++ /dev/null
@@ -1,63 +0,0 @@
-// Licensed to the .NET Foundation under one or more agreements.
-// The .NET Foundation licenses this file to you under the MIT license.
-
-using System.Globalization;
-using BenchmarkDotNet.Attributes;
-using Microsoft.OpenApi.Any;
-using Microsoft.OpenApi.Interfaces;
-using Microsoft.OpenApi.Models;
-
-namespace Microsoft.AspNetCore.OpenApi.Microbenchmarks;
-
-public class OpenApiSchemaComparerBenchmark
-{
- [Params(1, 10, 100)]
- public int ElementCount { get; set; }
-
- private OpenApiSchema _schema;
-
- [GlobalSetup]
- public void OpenApiSchema_Setup()
- {
- _schema = new OpenApiSchema
- {
- AdditionalProperties = GenerateInnerSchema(),
- AdditionalPropertiesAllowed = true,
- AllOf = Enumerable.Range(0, ElementCount).Select(_ => GenerateInnerSchema()).ToList(),
- AnyOf = Enumerable.Range(0, ElementCount).Select(_ => GenerateInnerSchema()).ToList(),
- Deprecated = true,
- Default = new OpenApiString("default"),
- Description = "description",
- Discriminator = new OpenApiDiscriminator(),
- Example = new OpenApiString("example"),
- ExclusiveMaximum = true,
- ExclusiveMinimum = true,
- Extensions = new Dictionary
- {
- ["key"] = new OpenApiString("value")
- },
- ExternalDocs = new OpenApiExternalDocs(),
- Enum = Enumerable.Range(0, ElementCount).Select(_ => (IOpenApiAny)new OpenApiString("enum")).ToList(),
- OneOf = Enumerable.Range(0, ElementCount).Select(_ => GenerateInnerSchema()).ToList(),
- };
-
- static OpenApiSchema GenerateInnerSchema() => new OpenApiSchema
- {
- Properties = Enumerable.Range(0, 10).ToDictionary(i => i.ToString(CultureInfo.InvariantCulture), _ => new OpenApiSchema()),
- Deprecated = true,
- Default = new OpenApiString("default"),
- Description = "description",
- Example = new OpenApiString("example"),
- Extensions = new Dictionary
- {
- ["key"] = new OpenApiString("value")
- },
- };
- }
-
- [Benchmark]
- public int OpenApiSchema_GetHashCode() => OpenApiSchemaComparer.Instance.GetHashCode(_schema);
-
- [Benchmark]
- public OpenApiSchema OpenApiSchema_Clone() => OpenApiSchemaExtensions.Clone(_schema);
-}
diff --git a/src/OpenApi/perf/Microbenchmarks/TransformersBenchmark.cs b/src/OpenApi/perf/Microbenchmarks/TransformersBenchmark.cs
index a5a117b54bd9..d7fca2c1bcf5 100644
--- a/src/OpenApi/perf/Microbenchmarks/TransformersBenchmark.cs
+++ b/src/OpenApi/perf/Microbenchmarks/TransformersBenchmark.cs
@@ -104,11 +104,11 @@ public void SchemaTransformer_Setup()
{
if (context.JsonTypeInfo.Type == typeof(Todo) && context.ParameterDescription != null)
{
- schema.Extensions["x-my-extension"] = new OpenApiString(context.ParameterDescription.Name);
+ schema.Extensions["x-my-extension"] = new OpenApiAny(context.ParameterDescription.Name);
}
else
{
- schema.Extensions["x-my-extension"] = new OpenApiString("response");
+ schema.Extensions["x-my-extension"] = new OpenApiAny("response");
}
return Task.CompletedTask;
});
@@ -177,11 +177,11 @@ public Task TransformAsync(OpenApiSchema schema, OpenApiSchemaTransformerContext
{
if (context.JsonTypeInfo.Type == typeof(Todo) && context.ParameterDescription != null)
{
- schema.Extensions["x-my-extension"] = new OpenApiString(context.ParameterDescription.Name);
+ schema.Extensions["x-my-extension"] = new OpenApiAny(context.ParameterDescription.Name);
}
else
{
- schema.Extensions["x-my-extension"] = new OpenApiString("response");
+ schema.Extensions["x-my-extension"] = new OpenApiAny("response");
}
return Task.CompletedTask;
}
diff --git a/src/OpenApi/sample/Transformers/AddExternalDocsTransformer.cs b/src/OpenApi/sample/Transformers/AddExternalDocsTransformer.cs
index 6af558870e0d..acc4402c32f6 100644
--- a/src/OpenApi/sample/Transformers/AddExternalDocsTransformer.cs
+++ b/src/OpenApi/sample/Transformers/AddExternalDocsTransformer.cs
@@ -29,7 +29,7 @@ public Task TransformAsync(OpenApiSchema schema, OpenApiSchemaTransformerContext
{
if (Uri.TryCreate(configuration["DocumentationBaseUrl"], UriKind.Absolute, out var baseUri))
{
- var url = new Uri(baseUri, $"/api/docs/schemas/{Uri.EscapeDataString(schema.Type)}");
+ var url = new Uri(baseUri, $"/api/docs/schemas/{Uri.EscapeDataString(schema.Type.ToString()!)}");
schema.ExternalDocs = new OpenApiExternalDocs
{
diff --git a/src/OpenApi/sample/Transformers/OperationTransformers.cs b/src/OpenApi/sample/Transformers/OperationTransformers.cs
index b1427762e09b..0c90f63d8e1a 100644
--- a/src/OpenApi/sample/Transformers/OperationTransformers.cs
+++ b/src/OpenApi/sample/Transformers/OperationTransformers.cs
@@ -2,7 +2,6 @@
// The .NET Foundation licenses this file to you under the MIT license.
using Microsoft.AspNetCore.OpenApi;
-using Microsoft.OpenApi.Any;
using Microsoft.OpenApi.Extensions;
using Microsoft.OpenApi.Models;
@@ -15,7 +14,7 @@ public static OpenApiOptions AddHeader(this OpenApiOptions options, string heade
return options.AddOperationTransformer((operation, context, cancellationToken) =>
{
var schema = OpenApiTypeMapper.MapTypeToOpenApiPrimitiveType(typeof(string));
- schema.Default = new OpenApiString(defaultValue);
+ schema.Default = defaultValue;
operation.Parameters ??= [];
operation.Parameters.Add(new OpenApiParameter
{
diff --git a/src/OpenApi/src/Comparers/ComparerHelpers.cs b/src/OpenApi/src/Comparers/ComparerHelpers.cs
deleted file mode 100644
index 3baa530db866..000000000000
--- a/src/OpenApi/src/Comparers/ComparerHelpers.cs
+++ /dev/null
@@ -1,95 +0,0 @@
-// Licensed to the .NET Foundation under one or more agreements.
-// The .NET Foundation licenses this file to you under the MIT license.
-
-namespace Microsoft.AspNetCore.OpenApi;
-
-internal static class ComparerHelpers
-{
- internal static bool DictionaryEquals(IDictionary x, IDictionary y, IEqualityComparer comparer)
- where TKey : notnull
- where TValue : notnull
- {
- if (x is Dictionary xDictionary && y is Dictionary yDictionary)
- {
- return DictionaryEquals(xDictionary, yDictionary, comparer);
- }
-
- if (x.Keys.Count != y.Keys.Count)
- {
- return false;
- }
-
- foreach (var key in x.Keys)
- {
- if (!y.TryGetValue(key, out var value) || !comparer.Equals(x[key], value))
- {
- return false;
- }
- }
-
- return true;
- }
-
- // Private method to avoid interface dispatch.
- private static bool DictionaryEquals(Dictionary x, Dictionary y, IEqualityComparer comparer)
- where TKey : notnull
- where TValue : notnull
- {
- if (x.Keys.Count != y.Keys.Count)
- {
- return false;
- }
-
- foreach (var key in x.Keys)
- {
- if (!y.TryGetValue(key, out var value) || !comparer.Equals(x[key], value))
- {
- return false;
- }
- }
-
- return true;
- }
-
- internal static bool ListEquals(IList x, IList y, IEqualityComparer comparer)
- {
- if (x is List xList && y is List yList)
- {
- return ListEquals(xList, yList, comparer);
- }
-
- if (x.Count != y.Count)
- {
- return false;
- }
-
- for (var i = 0; i < x.Count; i++)
- {
- if (!comparer.Equals(x[i], y[i]))
- {
- return false;
- }
- }
-
- return true;
- }
-
- // Private method to avoid interface dispatch.
- private static bool ListEquals(List x, List y, IEqualityComparer comparer)
- {
- if (x.Count != y.Count)
- {
- return false;
- }
-
- for (var i = 0; i < x.Count; i++)
- {
- if (!comparer.Equals(x[i], y[i]))
- {
- return false;
- }
- }
-
- return true;
- }
-}
diff --git a/src/OpenApi/src/Comparers/OpenApiAnyComparer.cs b/src/OpenApi/src/Comparers/OpenApiAnyComparer.cs
deleted file mode 100644
index 5ba27568899d..000000000000
--- a/src/OpenApi/src/Comparers/OpenApiAnyComparer.cs
+++ /dev/null
@@ -1,117 +0,0 @@
-// Licensed to the .NET Foundation under one or more agreements.
-// The .NET Foundation licenses this file to you under the MIT license.
-
-using System.Linq;
-using Microsoft.OpenApi.Any;
-using Microsoft.OpenApi.Interfaces;
-
-namespace Microsoft.AspNetCore.OpenApi;
-
-internal sealed class OpenApiAnyComparer : IEqualityComparer, IEqualityComparer
-{
- public static OpenApiAnyComparer Instance { get; } = new OpenApiAnyComparer();
-
- public bool Equals(IOpenApiAny? x, IOpenApiAny? y)
- {
- if (x is null && y is null)
- {
- return true;
- }
- if (x is null || y is null)
- {
- return false;
- }
- if (object.ReferenceEquals(x, y))
- {
- return true;
- }
-
- return x.AnyType == y.AnyType &&
- (x switch
- {
- OpenApiNull _ => y is OpenApiNull,
- OpenApiArray arrayX => y is OpenApiArray arrayY && ComparerHelpers.ListEquals(arrayX, arrayY, Instance),
- OpenApiObject objectX => y is OpenApiObject objectY && ComparerHelpers.DictionaryEquals(objectX, objectY, Instance),
- OpenApiBinary binaryX => y is OpenApiBinary binaryY && binaryX.Value.SequenceEqual(binaryY.Value),
- OpenApiInteger integerX => y is OpenApiInteger integerY && integerX.Value == integerY.Value,
- OpenApiLong longX => y is OpenApiLong longY && longX.Value == longY.Value,
- OpenApiDouble doubleX => y is OpenApiDouble doubleY && doubleX.Value == doubleY.Value,
- OpenApiFloat floatX => y is OpenApiFloat floatY && floatX.Value == floatY.Value,
- OpenApiBoolean booleanX => y is OpenApiBoolean booleanY && booleanX.Value == booleanY.Value,
- OpenApiString stringX => y is OpenApiString stringY && stringX.Value == stringY.Value,
- OpenApiPassword passwordX => y is OpenApiPassword passwordY && passwordX.Value == passwordY.Value,
- OpenApiByte byteX => y is OpenApiByte byteY && byteX.Value.SequenceEqual(byteY.Value),
- OpenApiDate dateX => y is OpenApiDate dateY && dateX.Value == dateY.Value,
- OpenApiDateTime dateTimeX => y is OpenApiDateTime dateTimeY && dateTimeX.Value == dateTimeY.Value,
- _ => x.Equals(y)
- });
- }
-
- public int GetHashCode(IOpenApiAny obj)
- {
- var hashCode = new HashCode();
- hashCode.Add(obj.AnyType);
- if (obj is IOpenApiPrimitive primitive)
- {
- hashCode.Add(primitive.PrimitiveType);
- }
- if (obj is OpenApiBinary binary)
- {
- hashCode.AddBytes(binary.Value);
- }
- if (obj is OpenApiByte bytes)
- {
- hashCode.AddBytes(bytes.Value);
- }
- hashCode.Add(obj switch
- {
- OpenApiInteger integer => integer.Value,
- OpenApiLong @long => @long.Value,
- OpenApiDouble @double => @double.Value,
- OpenApiFloat @float => @float.Value,
- OpenApiBoolean boolean => boolean.Value,
- OpenApiString @string => @string.Value,
- OpenApiPassword password => password.Value,
- OpenApiDate date => date.Value,
- OpenApiDateTime dateTime => dateTime.Value,
- _ => null
- });
-
- return hashCode.ToHashCode();
- }
-
- public bool Equals(IOpenApiExtension? x, IOpenApiExtension? y)
- {
- if (x is null && y is null)
- {
- return true;
- }
-
- if (x is null || y is null)
- {
- return false;
- }
-
- if (object.ReferenceEquals(x, y))
- {
- return true;
- }
-
- if (x is IOpenApiAny openApiAnyX && y is IOpenApiAny openApiAnyY)
- {
- return Equals(openApiAnyX, openApiAnyY);
- }
-
- return x.Equals(y);
- }
-
- public int GetHashCode(IOpenApiExtension obj)
- {
- if (obj is IOpenApiAny any)
- {
- return GetHashCode(any);
- }
-
- return obj.GetHashCode();
- }
-}
diff --git a/src/OpenApi/src/Comparers/OpenApiDiscriminatorComparer.cs b/src/OpenApi/src/Comparers/OpenApiDiscriminatorComparer.cs
deleted file mode 100644
index c4547b07d591..000000000000
--- a/src/OpenApi/src/Comparers/OpenApiDiscriminatorComparer.cs
+++ /dev/null
@@ -1,39 +0,0 @@
-// Licensed to the .NET Foundation under one or more agreements.
-// The .NET Foundation licenses this file to you under the MIT license.
-
-using Microsoft.OpenApi.Models;
-
-namespace Microsoft.AspNetCore.OpenApi;
-
-internal sealed class OpenApiDiscriminatorComparer : IEqualityComparer
-{
- public static OpenApiDiscriminatorComparer Instance { get; } = new OpenApiDiscriminatorComparer();
-
- public bool Equals(OpenApiDiscriminator? x, OpenApiDiscriminator? y)
- {
- if (x is null && y is null)
- {
- return true;
- }
- if (x is null || y is null)
- {
- return false;
- }
- if (object.ReferenceEquals(x, y))
- {
- return true;
- }
-
- return x.PropertyName == y.PropertyName &&
- x.Mapping.Count == y.Mapping.Count &&
- ComparerHelpers.DictionaryEquals(x.Mapping, y.Mapping, StringComparer.Ordinal);
- }
-
- public int GetHashCode(OpenApiDiscriminator obj)
- {
- var hashCode = new HashCode();
- hashCode.Add(obj.PropertyName);
- hashCode.Add(obj.Mapping.Count);
- return hashCode.ToHashCode();
- }
-}
diff --git a/src/OpenApi/src/Comparers/OpenApiExternalDocsComparer.cs b/src/OpenApi/src/Comparers/OpenApiExternalDocsComparer.cs
deleted file mode 100644
index 499b245911f8..000000000000
--- a/src/OpenApi/src/Comparers/OpenApiExternalDocsComparer.cs
+++ /dev/null
@@ -1,40 +0,0 @@
-// Licensed to the .NET Foundation under one or more agreements.
-// The .NET Foundation licenses this file to you under the MIT license.
-
-using Microsoft.OpenApi.Models;
-
-namespace Microsoft.AspNetCore.OpenApi;
-
-internal sealed class OpenApiExternalDocsComparer : IEqualityComparer
-{
- public static OpenApiExternalDocsComparer Instance { get; } = new OpenApiExternalDocsComparer();
-
- public bool Equals(OpenApiExternalDocs? x, OpenApiExternalDocs? y)
- {
- if (x is null && y is null)
- {
- return true;
- }
- if (x is null || y is null)
- {
- return false;
- }
- if (object.ReferenceEquals(x, y))
- {
- return true;
- }
-
- return x.Description == y.Description &&
- x.Url == y.Url &&
- ComparerHelpers.DictionaryEquals(x.Extensions, y.Extensions, OpenApiAnyComparer.Instance);
- }
-
- public int GetHashCode(OpenApiExternalDocs obj)
- {
- var hashCode = new HashCode();
- hashCode.Add(obj.Description);
- hashCode.Add(obj.Url);
- hashCode.Add(obj.Extensions.Count);
- return hashCode.ToHashCode();
- }
-}
diff --git a/src/OpenApi/src/Comparers/OpenApiReferenceComparer.cs b/src/OpenApi/src/Comparers/OpenApiReferenceComparer.cs
deleted file mode 100644
index d01175bf6740..000000000000
--- a/src/OpenApi/src/Comparers/OpenApiReferenceComparer.cs
+++ /dev/null
@@ -1,46 +0,0 @@
-// Licensed to the .NET Foundation under one or more agreements.
-// The .NET Foundation licenses this file to you under the MIT license.
-
-using Microsoft.OpenApi.Models;
-
-namespace Microsoft.AspNetCore.OpenApi;
-
-internal sealed class OpenApiReferenceComparer : IEqualityComparer
-{
- public static OpenApiReferenceComparer Instance { get; } = new OpenApiReferenceComparer();
-
- public bool Equals(OpenApiReference? x, OpenApiReference? y)
- {
- if (x is null && y is null)
- {
- return true;
- }
- if (x is null || y is null)
- {
- return false;
- }
- if (object.ReferenceEquals(x, y))
- {
- return true;
- }
-
- // We avoid comparing the HostDocument that a reference is associated with
- // so that the same schema in the OpenApiSchemaStore cache and embedded in
- // an OpenAPI document is considered equal.
- return x.ExternalResource == y.ExternalResource &&
- x.Id == y.Id &&
- x.Type == y.Type;
- }
-
- public int GetHashCode(OpenApiReference obj)
- {
- var hashCode = new HashCode();
- hashCode.Add(obj.ExternalResource);
- hashCode.Add(obj.Id);
- if (obj.Type is not null)
- {
- hashCode.Add(obj.Type);
- }
- return hashCode.ToHashCode();
- }
-}
diff --git a/src/OpenApi/src/Comparers/OpenApiSchemaComparer.cs b/src/OpenApi/src/Comparers/OpenApiSchemaComparer.cs
deleted file mode 100644
index 0591035d2f47..000000000000
--- a/src/OpenApi/src/Comparers/OpenApiSchemaComparer.cs
+++ /dev/null
@@ -1,142 +0,0 @@
-// Licensed to the .NET Foundation under one or more agreements.
-// The .NET Foundation licenses this file to you under the MIT license.
-
-using Microsoft.OpenApi.Models;
-
-namespace Microsoft.AspNetCore.OpenApi;
-
-internal sealed class OpenApiSchemaComparer : IEqualityComparer
-{
- public static OpenApiSchemaComparer Instance { get; } = new OpenApiSchemaComparer();
-
- public bool Equals(OpenApiSchema? x, OpenApiSchema? y)
- {
- if (x is null && y is null)
- {
- return true;
- }
- if (x is null || y is null)
- {
- return false;
- }
- if (object.ReferenceEquals(x, y))
- {
- return true;
- }
-
- // Compare property equality in an order that should help us find inequality faster
- return
- x.Type == y.Type &&
- x.Format == y.Format &&
- SchemaIdEquals(x, y) &&
- ComparerHelpers.DictionaryEquals(x.Properties, y.Properties, Instance) &&
- OpenApiDiscriminatorComparer.Instance.Equals(x.Discriminator, y.Discriminator) &&
- Instance.Equals(x.AdditionalProperties, y.AdditionalProperties) &&
- x.AdditionalPropertiesAllowed == y.AdditionalPropertiesAllowed &&
- ComparerHelpers.ListEquals(x.AllOf, y.AllOf, Instance) &&
- ComparerHelpers.ListEquals(x.AnyOf, y.AnyOf, Instance) &&
- x.Deprecated == y.Deprecated &&
- OpenApiAnyComparer.Instance.Equals(x.Default, y.Default) &&
- x.Description == y.Description &&
- OpenApiAnyComparer.Instance.Equals(x.Example, y.Example) &&
- x.ExclusiveMaximum == y.ExclusiveMaximum &&
- x.ExclusiveMinimum == y.ExclusiveMinimum &&
- x.Extensions.Count == y.Extensions.Count &&
- ComparerHelpers.DictionaryEquals(x.Extensions, y.Extensions, OpenApiAnyComparer.Instance) &&
- OpenApiExternalDocsComparer.Instance.Equals(x.ExternalDocs, y.ExternalDocs) &&
- ComparerHelpers.ListEquals(x.Enum, y.Enum, OpenApiAnyComparer.Instance) &&
- Instance.Equals(x.Items, y.Items) &&
- x.Title == y.Title &&
- x.Maximum == y.Maximum &&
- x.MaxItems == y.MaxItems &&
- x.MaxLength == y.MaxLength &&
- x.MaxProperties == y.MaxProperties &&
- x.Minimum == y.Minimum &&
- x.MinItems == y.MinItems &&
- x.MinLength == y.MinLength &&
- x.MinProperties == y.MinProperties &&
- x.MultipleOf == y.MultipleOf &&
- ComparerHelpers.ListEquals(x.OneOf, y.OneOf, Instance) &&
- Instance.Equals(x.Not, y.Not) &&
- x.Nullable == y.Nullable &&
- x.Pattern == y.Pattern &&
- x.ReadOnly == y.ReadOnly &&
- x.Required.Count == y.Required.Count && x.Required.SetEquals(y.Required) &&
- OpenApiReferenceComparer.Instance.Equals(x.Reference, y.Reference) &&
- x.UniqueItems == y.UniqueItems &&
- x.UnresolvedReference == y.UnresolvedReference &&
- x.WriteOnly == y.WriteOnly &&
- OpenApiXmlComparer.Instance.Equals(x.Xml, y.Xml);
- }
-
- private static bool SchemaIdEquals(OpenApiSchema x, OpenApiSchema y)
- {
- if (x.Annotations == null && y.Annotations == null)
- {
- return true;
- }
- if (x.Annotations == null || y.Annotations == null)
- {
- return false;
- }
- if (x.Annotations.TryGetValue(OpenApiConstants.SchemaId, out var xSchemaId)
- && y.Annotations.TryGetValue(OpenApiConstants.SchemaId, out var ySchemaId))
- {
- if (xSchemaId == null && ySchemaId == null)
- {
- return true;
- }
- if (xSchemaId == null || ySchemaId == null)
- {
- return false;
- }
- return xSchemaId.Equals(ySchemaId);
- }
- return true;
- }
-
- public int GetHashCode(OpenApiSchema obj)
- {
- var hashCode = new HashCode();
- hashCode.Add(obj.AdditionalProperties, Instance);
- hashCode.Add(obj.AdditionalPropertiesAllowed);
- hashCode.Add(obj.AllOf.Count);
- hashCode.Add(obj.AnyOf.Count);
- hashCode.Add(obj.Deprecated);
- hashCode.Add(obj.Default, OpenApiAnyComparer.Instance);
- hashCode.Add(obj.Description);
- hashCode.Add(obj.Discriminator, OpenApiDiscriminatorComparer.Instance);
- hashCode.Add(obj.Example, OpenApiAnyComparer.Instance);
- hashCode.Add(obj.ExclusiveMaximum);
- hashCode.Add(obj.ExclusiveMinimum);
- hashCode.Add(obj.Extensions.Count);
- hashCode.Add(obj.ExternalDocs, OpenApiExternalDocsComparer.Instance);
- hashCode.Add(obj.Enum.Count);
- hashCode.Add(obj.Format);
- hashCode.Add(obj.Items, Instance);
- hashCode.Add(obj.Title);
- hashCode.Add(obj.Type);
- hashCode.Add(obj.Maximum);
- hashCode.Add(obj.MaxItems);
- hashCode.Add(obj.MaxLength);
- hashCode.Add(obj.MaxProperties);
- hashCode.Add(obj.Minimum);
- hashCode.Add(obj.MinItems);
- hashCode.Add(obj.MinLength);
- hashCode.Add(obj.MinProperties);
- hashCode.Add(obj.MultipleOf);
- hashCode.Add(obj.OneOf.Count);
- hashCode.Add(obj.Not, Instance);
- hashCode.Add(obj.Nullable);
- hashCode.Add(obj.Pattern);
- hashCode.Add(obj.Properties.Count);
- hashCode.Add(obj.ReadOnly);
- hashCode.Add(obj.Required.Count);
- hashCode.Add(obj.Reference, OpenApiReferenceComparer.Instance);
- hashCode.Add(obj.UniqueItems);
- hashCode.Add(obj.UnresolvedReference);
- hashCode.Add(obj.WriteOnly);
- hashCode.Add(obj.Xml, OpenApiXmlComparer.Instance);
- return hashCode.ToHashCode();
- }
-}
diff --git a/src/OpenApi/src/Comparers/OpenApiXmlComparer.cs b/src/OpenApi/src/Comparers/OpenApiXmlComparer.cs
deleted file mode 100644
index bfe71ef51f6c..000000000000
--- a/src/OpenApi/src/Comparers/OpenApiXmlComparer.cs
+++ /dev/null
@@ -1,46 +0,0 @@
-// Licensed to the .NET Foundation under one or more agreements.
-// The .NET Foundation licenses this file to you under the MIT license.
-
-using Microsoft.OpenApi.Models;
-
-namespace Microsoft.AspNetCore.OpenApi;
-
-internal sealed class OpenApiXmlComparer : IEqualityComparer
-{
- public static OpenApiXmlComparer Instance { get; } = new OpenApiXmlComparer();
-
- public bool Equals(OpenApiXml? x, OpenApiXml? y)
- {
- if (x is null && y is null)
- {
- return true;
- }
- if (x is null || y is null)
- {
- return false;
- }
- if (object.ReferenceEquals(x, y))
- {
- return true;
- }
-
- return x.Name == y.Name &&
- x.Namespace == y.Namespace &&
- x.Prefix == y.Prefix &&
- x.Attribute == y.Attribute &&
- x.Wrapped == y.Wrapped &&
- ComparerHelpers.DictionaryEquals(x.Extensions, y.Extensions, OpenApiAnyComparer.Instance);
- }
-
- public int GetHashCode(OpenApiXml obj)
- {
- var hashCode = new HashCode();
- hashCode.Add(obj.Name);
- hashCode.Add(obj.Namespace);
- hashCode.Add(obj.Prefix);
- hashCode.Add(obj.Attribute);
- hashCode.Add(obj.Wrapped);
- hashCode.Add(obj.Extensions.Count);
- return hashCode.ToHashCode();
- }
-}
diff --git a/src/OpenApi/src/Extensions/JsonNodeSchemaExtensions.cs b/src/OpenApi/src/Extensions/JsonNodeSchemaExtensions.cs
index a569a81daea4..0c1f8a8643b4 100644
--- a/src/OpenApi/src/Extensions/JsonNodeSchemaExtensions.cs
+++ b/src/OpenApi/src/Extensions/JsonNodeSchemaExtensions.cs
@@ -27,26 +27,26 @@ internal static class JsonNodeSchemaExtensions
{
private static readonly Dictionary _simpleTypeToOpenApiSchema = new()
{
- [typeof(bool)] = new() { Type = "boolean" },
- [typeof(byte)] = new() { Type = "integer", Format = "uint8" },
- [typeof(byte[])] = new() { Type = "string", Format = "byte" },
- [typeof(int)] = new() { Type = "integer", Format = "int32" },
- [typeof(uint)] = new() { Type = "integer", Format = "uint32" },
- [typeof(long)] = new() { Type = "integer", Format = "int64" },
- [typeof(ulong)] = new() { Type = "integer", Format = "uint64" },
- [typeof(short)] = new() { Type = "integer", Format = "int16" },
- [typeof(ushort)] = new() { Type = "integer", Format = "uint16" },
- [typeof(float)] = new() { Type = "number", Format = "float" },
- [typeof(double)] = new() { Type = "number", Format = "double" },
- [typeof(decimal)] = new() { Type = "number", Format = "double" },
- [typeof(DateTime)] = new() { Type = "string", Format = "date-time" },
- [typeof(DateTimeOffset)] = new() { Type = "string", Format = "date-time" },
- [typeof(Guid)] = new() { Type = "string", Format = "uuid" },
- [typeof(char)] = new() { Type = "string", Format = "char" },
- [typeof(Uri)] = new() { Type = "string", Format = "uri" },
- [typeof(string)] = new() { Type = "string" },
- [typeof(TimeOnly)] = new() { Type = "string", Format = "time" },
- [typeof(DateOnly)] = new() { Type = "string", Format = "date" },
+ [typeof(bool)] = new() { Type = JsonSchemaType.Boolean },
+ [typeof(byte)] = new() { Type = JsonSchemaType.Integer, Format = "uint8" },
+ [typeof(byte[])] = new() { Type = JsonSchemaType.String, Format = "byte" },
+ [typeof(int)] = new() { Type = JsonSchemaType.Integer, Format = "int32" },
+ [typeof(uint)] = new() { Type = JsonSchemaType.Integer, Format = "uint32" },
+ [typeof(long)] = new() { Type = JsonSchemaType.Integer, Format = "int64" },
+ [typeof(ulong)] = new() { Type = JsonSchemaType.Integer, Format = "uint64" },
+ [typeof(short)] = new() { Type = JsonSchemaType.Integer, Format = "int16" },
+ [typeof(ushort)] = new() { Type = JsonSchemaType.Integer, Format = "uint16" },
+ [typeof(float)] = new() { Type = JsonSchemaType.Number, Format = "float" },
+ [typeof(double)] = new() { Type = JsonSchemaType.Number, Format = "double" },
+ [typeof(decimal)] = new() { Type = JsonSchemaType.Number, Format = "double" },
+ [typeof(DateTime)] = new() { Type = JsonSchemaType.String, Format = "date-time" },
+ [typeof(DateTimeOffset)] = new() { Type = JsonSchemaType.String, Format = "date-time" },
+ [typeof(Guid)] = new() { Type = JsonSchemaType.String, Format = "uuid" },
+ [typeof(char)] = new() { Type = JsonSchemaType.String, Format = "char" },
+ [typeof(Uri)] = new() { Type = JsonSchemaType.String, Format = "uri" },
+ [typeof(string)] = new() { Type = JsonSchemaType.String },
+ [typeof(TimeOnly)] = new() { Type = JsonSchemaType.String, Format = "time" },
+ [typeof(DateOnly)] = new() { Type = JsonSchemaType.String, Format = "date" },
};
///
@@ -86,7 +86,7 @@ internal static void ApplyValidationAttributes(this JsonNode schema, IEnumerable
{
if (attribute is Base64StringAttribute)
{
- schema[OpenApiSchemaKeywords.TypeKeyword] = "string";
+ schema[OpenApiSchemaKeywords.TypeKeyword] = JsonSchemaType.String.ToString();
schema[OpenApiSchemaKeywords.FormatKeyword] = "byte";
}
else if (attribute is RangeAttribute rangeAttribute)
@@ -131,7 +131,7 @@ internal static void ApplyValidationAttributes(this JsonNode schema, IEnumerable
}
else if (attribute is UrlAttribute)
{
- schema[OpenApiSchemaKeywords.TypeKeyword] = "string";
+ schema[OpenApiSchemaKeywords.TypeKeyword] = JsonSchemaType.String.ToString();
schema[OpenApiSchemaKeywords.FormatKeyword] = "uri";
}
else if (attribute is StringLengthAttribute stringLengthAttribute)
@@ -192,7 +192,7 @@ internal static void ApplyPrimitiveTypesAndFormats(this JsonNode schema, JsonSch
if (_simpleTypeToOpenApiSchema.TryGetValue(underlyingType ?? type, out var openApiSchema))
{
schema[OpenApiSchemaKeywords.NullableKeyword] = openApiSchema.Nullable || (schema[OpenApiSchemaKeywords.TypeKeyword] is JsonArray schemaType && schemaType.GetValues().Contains("null"));
- schema[OpenApiSchemaKeywords.TypeKeyword] = openApiSchema.Type;
+ schema[OpenApiSchemaKeywords.TypeKeyword] = openApiSchema.Type.ToString();
schema[OpenApiSchemaKeywords.FormatKeyword] = openApiSchema.Format;
schema[OpenApiConstants.SchemaId] = createSchemaReferenceId(context.TypeInfo);
schema[OpenApiSchemaKeywords.NullableKeyword] = underlyingType != null;
@@ -236,7 +236,7 @@ internal static void ApplyRouteConstraints(this JsonNode schema, IEnumerable
+ /// Registers a into the top-level components store on the
+ /// and returns a resolvable reference to it.
+ ///
+ /// The to register the schema onto.
+ /// The ID that serves as the key for the schema in the schema store.
+ /// The to register into the document.
+ /// An with a reference to the stored schema.
+ public static OpenApiSchema AddOpenApiSchemaByReference(this OpenApiDocument document, string schemaId, OpenApiSchema schema)
+ {
+ document.Components ??= new();
+ document.Components.Schemas ??= new Dictionary();
+ document.Components.Schemas[schemaId] = schema;
+ document.Workspace ??= new();
+ var location = document.BaseUri + "/components/schemas/" + schemaId;
+ document.Workspace.RegisterComponent(location, schema);
+ return new OpenApiSchemaReference(schemaId, document);
+ }
+}
diff --git a/src/OpenApi/src/Extensions/OpenApiSchemaExtensions.cs b/src/OpenApi/src/Extensions/OpenApiSchemaExtensions.cs
deleted file mode 100644
index a3f182147931..000000000000
--- a/src/OpenApi/src/Extensions/OpenApiSchemaExtensions.cs
+++ /dev/null
@@ -1,69 +0,0 @@
-// Licensed to the .NET Foundation under one or more agreements.
-// The .NET Foundation licenses this file to you under the MIT license.
-
-using System.Linq;
-using Microsoft.OpenApi.Any;
-using Microsoft.OpenApi.Interfaces;
-using Microsoft.OpenApi.Models;
-
-namespace Microsoft.AspNetCore.OpenApi;
-
-internal static class OpenApiSchemaExtensions
-{
- ///
- /// Generates a deep copy of a given instance.
- ///
- ///
- /// The copy constructors of the class do not perform a deep
- /// copy of the instance which presents a problem whe making modifications in deeply nested
- /// subschemas. This extension implements a deep copy on to guarantee
- /// that modifications on cloned subschemas do not affect the original subschema.
- /// ///
- /// The to generate a deep copy of.
- public static OpenApiSchema Clone(this OpenApiSchema schema)
- {
- return new OpenApiSchema
- {
- Title = schema.Title,
- Type = schema.Type,
- Format = schema.Format,
- Description = schema.Description,
- Maximum = schema.Maximum,
- ExclusiveMaximum = schema.ExclusiveMaximum,
- Minimum = schema.Minimum,
- ExclusiveMinimum = schema.ExclusiveMinimum,
- MaxLength = schema.MaxLength,
- MinLength = schema.MinLength,
- Pattern = schema.Pattern,
- MultipleOf = schema.MultipleOf,
- Default = OpenApiAnyCloneHelper.CloneFromCopyConstructor(schema.Default),
- ReadOnly = schema.ReadOnly,
- WriteOnly = schema.WriteOnly,
- AllOf = schema.AllOf != null ? new List(schema.AllOf.Select(s => s.Clone())) : null,
- OneOf = schema.OneOf != null ? new List(schema.OneOf.Select(s => s.Clone())) : null,
- AnyOf = schema.AnyOf != null ? new List(schema.AnyOf.Select(s => s.Clone())) : null,
- Not = schema.Not?.Clone(),
- Required = schema.Required != null ? new HashSet(schema.Required) : null,
- Items = schema.Items?.Clone(),
- MaxItems = schema.MaxItems,
- MinItems = schema.MinItems,
- UniqueItems = schema.UniqueItems,
- Properties = schema.Properties?.ToDictionary(kvp => kvp.Key, kvp => kvp.Value.Clone()),
- MaxProperties = schema.MaxProperties,
- MinProperties = schema.MinProperties,
- AdditionalPropertiesAllowed = schema.AdditionalPropertiesAllowed,
- AdditionalProperties = schema.AdditionalProperties?.Clone(),
- Discriminator = schema.Discriminator != null ? new(schema.Discriminator) : null,
- Example = OpenApiAnyCloneHelper.CloneFromCopyConstructor(schema.Example),
- Enum = schema.Enum != null ? new List(schema.Enum) : null,
- Nullable = schema.Nullable,
- ExternalDocs = schema.ExternalDocs != null ? new(schema.ExternalDocs) : null,
- Deprecated = schema.Deprecated,
- Xml = schema.Xml != null ? new(schema.Xml) : null,
- Extensions = schema.Extensions != null ? new Dictionary(schema.Extensions) : null,
- UnresolvedReference = schema.UnresolvedReference,
- Reference = schema.Reference != null ? new(schema.Reference) : null,
- Annotations = schema.Annotations != null ? new Dictionary(schema.Annotations) : null,
- };
- }
-}
diff --git a/src/OpenApi/src/Extensions/OpenApiServiceCollectionExtensions.cs b/src/OpenApi/src/Extensions/OpenApiServiceCollectionExtensions.cs
index 5e848bdc5851..45ae3e5dd2bf 100644
--- a/src/OpenApi/src/Extensions/OpenApiServiceCollectionExtensions.cs
+++ b/src/OpenApi/src/Extensions/OpenApiServiceCollectionExtensions.cs
@@ -110,7 +110,6 @@ private static IServiceCollection AddOpenApiCore(this IServiceCollection service
{
services.AddEndpointsApiExplorer();
services.AddKeyedSingleton(documentName);
- services.AddKeyedSingleton(documentName);
services.AddKeyedSingleton(documentName);
// Required for build-time generation
services.AddSingleton();
diff --git a/src/OpenApi/src/Schemas/OpenApiJsonSchema.Helpers.cs b/src/OpenApi/src/Schemas/OpenApiJsonSchema.Helpers.cs
index 830b0375d396..29e17c2f1363 100644
--- a/src/OpenApi/src/Schemas/OpenApiJsonSchema.Helpers.cs
+++ b/src/OpenApi/src/Schemas/OpenApiJsonSchema.Helpers.cs
@@ -1,11 +1,12 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
+using System.Diagnostics;
using System.Linq;
using System.Text.Json;
+using System.Text.Json.Nodes;
using System.Text.Json.Serialization;
using Microsoft.AspNetCore.OpenApi;
-using Microsoft.OpenApi.Any;
using Microsoft.OpenApi.Models;
using OpenApiConstants = Microsoft.AspNetCore.OpenApi.OpenApiConstants;
@@ -82,63 +83,63 @@ internal sealed partial class OpenApiJsonSchema
return values;
}
- internal static IOpenApiAny? ReadOpenApiAny(ref Utf8JsonReader reader)
- => ReadOpenApiAny(ref reader, out _);
+ internal static JsonNode? ReadJsonNode(ref Utf8JsonReader reader)
+ => ReadJsonNode(ref reader, out _);
- internal static IOpenApiAny? ReadOpenApiAny(ref Utf8JsonReader reader, out string? type)
+ internal static JsonNode? ReadJsonNode(ref Utf8JsonReader reader, out JsonSchemaType? type)
{
type = null;
if (reader.TokenType == JsonTokenType.Null)
{
- return new OpenApiNull();
+ return null;
}
if (reader.TokenType == JsonTokenType.True || reader.TokenType == JsonTokenType.False)
{
- type = "boolean";
- return new OpenApiBoolean(reader.GetBoolean());
+ type = JsonSchemaType.Boolean;
+ return reader.GetBoolean();
}
if (reader.TokenType == JsonTokenType.Number)
{
if (reader.TryGetInt32(out var intValue))
{
- type = "integer";
- return new OpenApiInteger(intValue);
+ type = JsonSchemaType.Integer;
+ return intValue;
}
if (reader.TryGetInt64(out var longValue))
{
- type = "integer";
- return new OpenApiLong(longValue);
+ type = JsonSchemaType.Integer;
+ return longValue;
}
if (reader.TryGetSingle(out var floatValue) && !float.IsInfinity(floatValue))
{
- type = "number";
- return new OpenApiFloat(floatValue);
+ type = JsonSchemaType.Number;
+ return floatValue;
}
if (reader.TryGetDouble(out var doubleValue))
{
- type = "number";
- return new OpenApiDouble(doubleValue);
+ type = JsonSchemaType.Number;
+ return doubleValue;
}
}
if (reader.TokenType == JsonTokenType.String)
{
- type = "string";
- return new OpenApiString(reader.GetString());
+ type = JsonSchemaType.String;
+ return reader.GetString();
}
if (reader.TokenType == JsonTokenType.StartArray)
{
- type = "array";
- var array = new OpenApiArray();
+ type = JsonSchemaType.Array;
+ var array = new JsonArray();
while (reader.TokenType != JsonTokenType.EndArray)
{
- array.Add(ReadOpenApiAny(ref reader));
+ array.Add(ReadJsonNode(ref reader));
reader.Read();
}
return array;
@@ -146,8 +147,8 @@ internal sealed partial class OpenApiJsonSchema
if (reader.TokenType == JsonTokenType.StartObject)
{
- type = "object";
- var obj = new OpenApiObject();
+ type = JsonSchemaType.Object;
+ var obj = new JsonObject();
reader.Read();
while (reader.TokenType != JsonTokenType.EndObject)
{
@@ -158,7 +159,7 @@ internal sealed partial class OpenApiJsonSchema
var key = reader.GetString()!;
reader.Read();
- obj[key] = ReadOpenApiAny(ref reader);
+ obj[key] = ReadJsonNode(ref reader);
reader.Read();
}
return obj;
@@ -185,37 +186,34 @@ public static void ReadProperty(ref Utf8JsonReader reader, string propertyName,
var types = ReadList(ref reader);
foreach (var type in types ?? [])
{
- // JSON Schema represents nullable types using an array consisting of
- // the target type and "null". Since OpenAPI Schema does not support
- // representing types within an array we must check for the "null" type
- // and map it to OpenAPI's `nullable` property for OpenAPI v3.
- if (type == "null")
+ if (schema.Type is not null)
{
- schema.Nullable = true;
+ schema.Type |= Enum.Parse(type, ignoreCase: true);
}
else
{
- schema.Type = type;
+ schema.Type = Enum.Parse(type, ignoreCase: true);
}
}
}
else
{
var type = reader.GetString();
- schema.Type = type;
+ Debug.Assert(type is not null);
+ schema.Type = Enum.Parse(type, ignoreCase: true);
}
break;
case OpenApiSchemaKeywords.EnumKeyword:
reader.Read();
- var enumValues = ReadList(ref reader);
+ var enumValues = ReadList(ref reader);
if (enumValues is not null)
{
- schema.Enum = enumValues.Select(v => new OpenApiString(v)).ToList();
+ schema.Enum = enumValues;
}
break;
case OpenApiSchemaKeywords.DefaultKeyword:
reader.Read();
- schema.Default = ReadOpenApiAny(ref reader);
+ schema.Default = ReadJsonNode(ref reader);
break;
case OpenApiSchemaKeywords.ItemsKeyword:
reader.Read();
@@ -290,7 +288,7 @@ public static void ReadProperty(ref Utf8JsonReader reader, string propertyName,
break;
case OpenApiSchemaKeywords.AnyOfKeyword:
reader.Read();
- schema.Type = "object";
+ schema.Type = JsonSchemaType.Object;
var schemas = ReadList(ref reader);
schema.AnyOf = schemas?.Select(s => s.Schema).ToList();
break;
@@ -319,7 +317,7 @@ public static void ReadProperty(ref Utf8JsonReader reader, string propertyName,
// we map it to its closest approximation, an enum with a single value, here.
case OpenApiSchemaKeywords.ConstKeyword:
reader.Read();
- schema.Enum = [ReadOpenApiAny(ref reader, out var constType)];
+ schema.Enum = [ReadJsonNode(ref reader, out var constType)];
schema.Type = constType;
break;
case OpenApiSchemaKeywords.RefKeyword:
diff --git a/src/OpenApi/src/Schemas/OpenApiJsonSchemaContext.cs b/src/OpenApi/src/Schemas/OpenApiJsonSchemaContext.cs
index b2be4b47b8df..dffca479b20c 100644
--- a/src/OpenApi/src/Schemas/OpenApiJsonSchemaContext.cs
+++ b/src/OpenApi/src/Schemas/OpenApiJsonSchemaContext.cs
@@ -1,10 +1,12 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
+using System.Text.Json.Nodes;
using System.Text.Json.Serialization;
namespace Microsoft.AspNetCore.OpenApi;
[JsonSerializable(typeof(OpenApiJsonSchema))]
[JsonSerializable(typeof(string))]
+[JsonSerializable(typeof(JsonNode))]
internal sealed partial class OpenApiJsonSchemaContext : JsonSerializerContext { }
diff --git a/src/OpenApi/src/Services/OpenApiDocumentService.cs b/src/OpenApi/src/Services/OpenApiDocumentService.cs
index d082c92582f6..db32e0512642 100644
--- a/src/OpenApi/src/Services/OpenApiDocumentService.cs
+++ b/src/OpenApi/src/Services/OpenApiDocumentService.cs
@@ -39,7 +39,6 @@ internal sealed class OpenApiDocumentService(
{
private readonly OpenApiOptions _options = optionsMonitor.Get(documentName);
private readonly OpenApiSchemaService _componentService = serviceProvider.GetRequiredKeyedService(documentName);
- private readonly OpenApiSchemaReferenceTransformer _schemaReferenceTransformer = new();
///
/// Cache of instances keyed by the
@@ -57,9 +56,6 @@ internal bool TryGetCachedOperationTransformerContext(string descriptionId, [Not
public async Task GetOpenApiDocumentAsync(IServiceProvider scopedServiceProvider, CancellationToken cancellationToken = default)
{
- // For good hygiene, operation-level tags must also appear in the document-level
- // tags collection. This set captures all tags that have been seen so far.
- HashSet capturedTags = new(OpenApiTagComparer.Instance);
// Schema and operation transformers are scoped per-request and can be
// pre-allocated to hold the same number of transformers as the associated
// options object.
@@ -73,18 +69,27 @@ public async Task GetOpenApiDocumentAsync(IServiceProvider scop
var document = new OpenApiDocument
{
Info = GetOpenApiInfo(),
- Paths = await GetOpenApiPathsAsync(capturedTags, scopedServiceProvider, operationTransformers, schemaTransformers, cancellationToken),
- Servers = GetOpenApiServers(),
- Tags = [.. capturedTags]
+ Servers = GetOpenApiServers()
};
+ document.Paths = await GetOpenApiPathsAsync(document, scopedServiceProvider, operationTransformers, schemaTransformers, cancellationToken);
+ document.Tags = document.Tags?.Distinct(OpenApiTagComparer.Instance).ToList();
try
{
await ApplyTransformersAsync(document, scopedServiceProvider, cancellationToken);
}
+
finally
{
await FinalizeTransformers(schemaTransformers, operationTransformers);
}
+ // Call register components to support
+ // resolution of references in the document.
+ document.Workspace ??= new();
+ document.Workspace.RegisterComponents(document);
+ if (document.Components?.Schemas is not null)
+ {
+ document.Components.Schemas = new SortedDictionary(document.Components.Schemas);
+ }
return document;
}
@@ -102,8 +107,6 @@ private async Task ApplyTransformersAsync(OpenApiDocument document, IServiceProv
var transformer = _options.DocumentTransformers[i];
await transformer.TransformAsync(document, documentTransformerContext, cancellationToken);
}
- // Move duplicated JSON schemas to the global components.schemas object and map references after all transformers have run.
- await _schemaReferenceTransformer.TransformAsync(document, documentTransformerContext, cancellationToken);
}
internal void InitializeTransformers(IServiceProvider scopedServiceProvider, IOpenApiSchemaTransformer[] schemaTransformers, IOpenApiOperationTransformer[] operationTransformers)
@@ -162,7 +165,8 @@ internal async Task ForEachOperationAsync(
continue;
}
- if (operation.Annotations.TryGetValue(OpenApiConstants.DescriptionId, out var descriptionId) &&
+ if (operation.Annotations is { } annotations &&
+ annotations.TryGetValue(OpenApiConstants.DescriptionId, out var descriptionId) &&
descriptionId is string descriptionIdString &&
TryGetCachedOperationTransformerContext(descriptionIdString, out var operationContext))
{
@@ -212,7 +216,7 @@ internal List GetOpenApiServers()
/// description instance into its appropriate document.
///
private async Task GetOpenApiPathsAsync(
- HashSet capturedTags,
+ OpenApiDocument document,
IServiceProvider scopedServiceProvider,
IOpenApiOperationTransformer[] operationTransformers,
IOpenApiSchemaTransformer[] schemaTransformers,
@@ -226,14 +230,14 @@ private async Task GetOpenApiPathsAsync(
foreach (var descriptions in descriptionsByPath)
{
Debug.Assert(descriptions.Key != null, "Relative path mapped to OpenApiPath key cannot be null.");
- paths.Add(descriptions.Key, new OpenApiPathItem { Operations = await GetOperationsAsync(descriptions, capturedTags, scopedServiceProvider, operationTransformers, schemaTransformers, cancellationToken) });
+ paths.Add(descriptions.Key, new OpenApiPathItem { Operations = await GetOperationsAsync(descriptions, document, scopedServiceProvider, operationTransformers, schemaTransformers, cancellationToken) });
}
return paths;
}
private async Task> GetOperationsAsync(
IGrouping descriptions,
- HashSet capturedTags,
+ OpenApiDocument document,
IServiceProvider scopedServiceProvider,
IOpenApiOperationTransformer[] operationTransformers,
IOpenApiSchemaTransformer[] schemaTransformers,
@@ -242,7 +246,7 @@ private async Task> GetOperationsAsy
var operations = new Dictionary();
foreach (var description in descriptions)
{
- var operation = await GetOperationAsync(description, capturedTags, scopedServiceProvider, schemaTransformers, cancellationToken);
+ var operation = await GetOperationAsync(description, document, scopedServiceProvider, schemaTransformers, cancellationToken);
operation.Annotations ??= new Dictionary();
operation.Annotations.Add(OpenApiConstants.DescriptionId, description.ActionDescriptor.Id);
@@ -268,7 +272,7 @@ private async Task> GetOperationsAsy
private async Task GetOperationAsync(
ApiDescription description,
- HashSet capturedTags,
+ OpenApiDocument document,
IServiceProvider scopedServiceProvider,
IOpenApiSchemaTransformer[] schemaTransformers,
CancellationToken cancellationToken)
@@ -278,7 +282,7 @@ private async Task GetOperationAsync(
{
foreach (var tag in tags)
{
- capturedTags.Add(tag);
+ document.Tags?.Add(tag);
}
}
var operation = new OpenApiOperation
@@ -286,9 +290,9 @@ private async Task GetOperationAsync(
OperationId = GetOperationId(description),
Summary = GetSummary(description),
Description = GetDescription(description),
- Responses = await GetResponsesAsync(description, scopedServiceProvider, schemaTransformers, cancellationToken),
- Parameters = await GetParametersAsync(description, scopedServiceProvider, schemaTransformers, cancellationToken),
- RequestBody = await GetRequestBodyAsync(description, scopedServiceProvider, schemaTransformers, cancellationToken),
+ Responses = await GetResponsesAsync(document, description, scopedServiceProvider, schemaTransformers, cancellationToken),
+ Parameters = await GetParametersAsync(document, description, scopedServiceProvider, schemaTransformers, cancellationToken),
+ RequestBody = await GetRequestBodyAsync(document, description, scopedServiceProvider, schemaTransformers, cancellationToken),
Tags = tags,
};
return operation;
@@ -317,6 +321,7 @@ private async Task GetOperationAsync(
}
private async Task GetResponsesAsync(
+ OpenApiDocument document,
ApiDescription description,
IServiceProvider scopedServiceProvider,
IOpenApiSchemaTransformer[] schemaTransformers,
@@ -329,7 +334,7 @@ private async Task GetResponsesAsync(
{
return new OpenApiResponses
{
- ["200"] = await GetResponseAsync(description, StatusCodes.Status200OK, _defaultApiResponseType, scopedServiceProvider, schemaTransformers, cancellationToken)
+ ["200"] = await GetResponseAsync(document, description, StatusCodes.Status200OK, _defaultApiResponseType, scopedServiceProvider, schemaTransformers, cancellationToken)
};
}
@@ -343,12 +348,13 @@ private async Task GetResponsesAsync(
var responseKey = responseType.IsDefaultResponse
? OpenApiConstants.DefaultOpenApiResponseKey
: responseType.StatusCode.ToString(CultureInfo.InvariantCulture);
- responses.Add(responseKey, await GetResponseAsync(description, responseType.StatusCode, responseType, scopedServiceProvider, schemaTransformers, cancellationToken));
+ responses.Add(responseKey, await GetResponseAsync(document, description, responseType.StatusCode, responseType, scopedServiceProvider, schemaTransformers, cancellationToken));
}
return responses;
}
private async Task GetResponseAsync(
+ OpenApiDocument document,
ApiDescription apiDescription,
int statusCode,
ApiResponseType apiResponseType,
@@ -370,7 +376,7 @@ private async Task GetResponseAsync(
.Select(responseFormat => responseFormat.MediaType);
foreach (var contentType in apiResponseFormatContentTypes)
{
- var schema = apiResponseType.Type is { } type ? await _componentService.GetOrCreateSchemaAsync(type, scopedServiceProvider, schemaTransformers, null, captureSchemaByRef: true, cancellationToken) : new OpenApiSchema();
+ var schema = apiResponseType.Type is { } type ? await _componentService.GetOrCreateSchemaAsync(document, type, scopedServiceProvider, schemaTransformers, null, cancellationToken) : new OpenApiSchema();
response.Content[contentType] = new OpenApiMediaType { Schema = schema };
}
@@ -389,6 +395,7 @@ private async Task GetResponseAsync(
}
private async Task?> GetParametersAsync(
+ OpenApiDocument document,
ApiDescription description,
IServiceProvider scopedServiceProvider,
IOpenApiSchemaTransformer[] schemaTransformers,
@@ -413,13 +420,14 @@ private async Task GetResponseAsync(
_ => ParameterLocation.Query
},
Required = IsRequired(parameter),
- Schema = await _componentService.GetOrCreateSchemaAsync(GetTargetType(description, parameter), scopedServiceProvider, schemaTransformers, parameter, cancellationToken: cancellationToken),
+ Schema = await _componentService.GetOrCreateSchemaAsync(document, GetTargetType(description, parameter), scopedServiceProvider, schemaTransformers, parameter, cancellationToken: cancellationToken),
Description = GetParameterDescriptionFromAttribute(parameter)
};
parameters ??= [];
parameters.Add(openApiParameter);
}
+
return parameters;
static bool ShouldIgnoreParameter(ApiParameterDescription parameter)
@@ -457,12 +465,12 @@ private static bool IsRequired(ApiParameterDescription parameter)
descriptionAttribute.Description :
null;
- private async Task GetRequestBodyAsync(ApiDescription description, IServiceProvider scopedServiceProvider, IOpenApiSchemaTransformer[] schemaTransformers, CancellationToken cancellationToken)
+ private async Task GetRequestBodyAsync(OpenApiDocument document, ApiDescription description, IServiceProvider scopedServiceProvider, IOpenApiSchemaTransformer[] schemaTransformers, CancellationToken cancellationToken)
{
// Only one parameter can be bound from the body in each request.
if (description.TryGetBodyParameter(out var bodyParameter))
{
- return await GetJsonRequestBody(description.SupportedRequestFormats, bodyParameter, scopedServiceProvider, schemaTransformers, cancellationToken);
+ return await GetJsonRequestBody(document, description.SupportedRequestFormats, bodyParameter, scopedServiceProvider, schemaTransformers, cancellationToken);
}
// If there are no body parameters, check for form parameters.
// Note: Form parameters and body parameters cannot exist simultaneously
@@ -470,12 +478,13 @@ private static bool IsRequired(ApiParameterDescription parameter)
if (description.TryGetFormParameters(out var formParameters))
{
var endpointMetadata = description.ActionDescriptor.EndpointMetadata;
- return await GetFormRequestBody(description.SupportedRequestFormats, formParameters, endpointMetadata, scopedServiceProvider, schemaTransformers, cancellationToken);
+ return await GetFormRequestBody(document, description.SupportedRequestFormats, formParameters, endpointMetadata, scopedServiceProvider, schemaTransformers, cancellationToken);
}
return null;
}
private async Task GetFormRequestBody(
+ OpenApiDocument document,
IList supportedRequestFormats,
IEnumerable formParameters,
IList