Update to latest OpenAPI

Author: bkoelman

package-versions.props

@@ -34,9 +34,13 @@
   <PropertyGroup Condition="'$(TargetFramework)' == 'net10.0'">
     <!-- Published dependencies (only update on major version change) -->
     <EntityFrameworkCoreFrozenVersion>10.0.*-*</EntityFrameworkCoreFrozenVersion>
+    <SwashbuckleFrozenVersion>9.0.0-pr.3283.*</SwashbuckleFrozenVersion>
 
     <!-- Non-published dependencies (these are safe to update, won't cause a breaking change) -->
     <AspNetCoreVersion>10.0.*-*</AspNetCoreVersion>
+    <SwashbuckleVersion>9.0.0-pr.3283.*</SwashbuckleVersion>
+    <MicrosoftOpenApiVersion>2.0.0-preview.21</MicrosoftOpenApiVersion>
+    <MicrosoftApiServerVersion>10.0.*-*</MicrosoftApiServerVersion>
     <EntityFrameworkCoreVersion>10.0.*-*</EntityFrameworkCoreVersion>
     <EntityFrameworkCorePomeloVersion>9.0.*-*</EntityFrameworkCorePomeloVersion>
   </PropertyGroup>

src/Examples/JsonApiDotNetCoreExample/JsonApiDotNetCoreExample.csproj

@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
   <PropertyGroup>
-    <TargetFrameworks>net10.0;net9.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>net10.0</TargetFrameworks>
     <OpenApiGenerateDocumentsOnBuild>true</OpenApiGenerateDocumentsOnBuild>
     <OpenApiDocumentsDirectory>GeneratedSwagger</OpenApiDocumentsDirectory>
   </PropertyGroup>

src/Examples/JsonApiDotNetCoreExample/SetOpenApiServerAtBuildTimeFilter.cs

@@ -16,6 +16,8 @@ public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
     {
         if (_httpContextAccessor.HttpContext == null)
         {
+            swaggerDoc.Servers ??= [];
+
             swaggerDoc.Servers.Add(new OpenApiServer
             {
                 Url = "https://localhost:44340"

src/JsonApiDotNetCore.OpenApi.Swashbuckle/ConfigureSwaggerGenOptions.cs

@@ -74,6 +74,8 @@ public void Configure(SwaggerGenOptions options)
         options.DocumentFilter<StringEnumOrderingFilter>();
         options.DocumentFilter<SetSchemaTypeToObjectDocumentFilter>();
         options.DocumentFilter<UnusedComponentSchemaCleaner>();
+        options.DocumentFilter<SortSchemasFilter>();
+        options.DocumentFilter<RemoveTagsFilter>();
     }
 
     private List<Type> SelectDerivedTypes(Type baseType)

src/JsonApiDotNetCore.OpenApi.Swashbuckle/JsonApiDotNetCore.OpenApi.Swashbuckle.csproj

@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFrameworks>net10.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>net10.0</TargetFrameworks>
     <IsPackable>true</IsPackable>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <OpenApiGenerateDocuments>false</OpenApiGenerateDocuments>
@@ -33,6 +33,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <PackageReference Include="Microsoft.OpenApi" Version="$(MicrosoftOpenApiVersion)" />
     <PackageReference Include="SauceControl.InheritDoc" Version="$(InheritDocVersion)" PrivateAssets="All" />
     <PackageReference Include="Swashbuckle.AspNetCore" Version="$(SwashbuckleFrozenVersion)" />
   </ItemGroup>

src/JsonApiDotNetCore.OpenApi.Swashbuckle/JsonApiSchemaIdSelector.cs

@@ -120,7 +120,7 @@ public string GetSchemaId(Type type)
 
     private string ApplySchemaTemplate(string schemaTemplate, ResourceType? resourceType, string? relationshipName, AtomicOperationCode? operationCode)
     {
-        string schemaId = schemaTemplate;
+        string? schemaId = schemaTemplate;
 
         schemaId = resourceType != null
             ? schemaId.Replace("[ResourceName]", resourceType.PublicName.Singularize()).Pascalize()
@@ -136,7 +136,7 @@ private string ApplySchemaTemplate(string schemaTemplate, ResourceType? resource
             schemaId = schemaId.Replace("[OperationCode]", operationCode.Value.ToString().Pascalize());
         }
 
-        string pascalCaseSchemaId = schemaId.Pascalize();
+        string? pascalCaseSchemaId = schemaId.Pascalize();
 
         JsonNamingPolicy? namingPolicy = _options.SerializerOptions.PropertyNamingPolicy;
         return namingPolicy != null ? namingPolicy.ConvertName(pascalCaseSchemaId) : pascalCaseSchemaId;

src/JsonApiDotNetCore.OpenApi.Swashbuckle/MicrosoftOpenApiCompatibilityExtensions.cs

@@ -0,0 +1,24 @@
+using Microsoft.OpenApi.Models;
+
+namespace JsonApiDotNetCore.OpenApi.Swashbuckle;
+
+internal static class MicrosoftOpenApiCompatibilityExtensions
+{
+    public static void SetNullable(this OpenApiSchema schema, bool nullable)
+    {
+        ArgumentNullException.ThrowIfNull(schema);
+
+        if (nullable)
+        {
+            schema.Type ??= JsonSchemaType.Null;
+            schema.Type |= JsonSchemaType.Null;
+        }
+        else
+        {
+            if (schema.Type != null)
+            {
+                schema.Type &= ~JsonSchemaType.Null;
+            }
+        }
+    }
+}

src/JsonApiDotNetCore.OpenApi.Swashbuckle/OpenApiDescriptionLinkProvider.cs

@@ -30,7 +30,7 @@ public OpenApiDescriptionLinkProvider(IOptionsMonitor<SwaggerGeneratorOptions> s
 
         if (swaggerGeneratorOptions.SwaggerDocs.Count > 0)
         {
-            string latestVersionDocumentName = swaggerGeneratorOptions.SwaggerDocs.Last().Key;
+            string? latestVersionDocumentName = swaggerGeneratorOptions.SwaggerDocs.Last().Key;
 
             SwaggerOptions swaggerOptions = _swaggerOptionsMonitor.CurrentValue;
             return swaggerOptions.RouteTemplate.Replace("{documentName}", latestVersionDocumentName).Replace("{extension:regex(^(json|ya?ml)$)}", "json");

src/JsonApiDotNetCore.OpenApi.Swashbuckle/OpenApiOperationIdSelector.cs

@@ -94,7 +94,7 @@ private string ApplyTemplate(string openApiOperationIdTemplate, ResourceType? re
         // @formatter:wrap_chained_method_calls chop_always
         // @formatter:wrap_before_first_method_call true
 
-        string pascalCaseOpenApiOperationId = openApiOperationIdTemplate
+        string? pascalCaseOpenApiOperationId = openApiOperationIdTemplate
             .Replace("[Method]", method)
             .Replace("[PrimaryResourceName]", resourceType?.PublicName.Singularize())
             .Replace("[RelationshipName]", relationshipName)

src/JsonApiDotNetCore.OpenApi.Swashbuckle/OpenApiSchemaExtensions.cs

@@ -1,4 +1,5 @@
 using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Models.Interfaces;
 
 namespace JsonApiDotNetCore.OpenApi.Swashbuckle;
 
@@ -9,22 +10,23 @@ public static void ReorderProperties(this OpenApiSchema fullSchema, IEnumerable<
         ArgumentNullException.ThrowIfNull(fullSchema);
         ArgumentNullException.ThrowIfNull(propertyNamesInOrder);
 
-        var propertiesInOrder = new Dictionary<string, OpenApiSchema>();
+        var propertiesInOrder = new Dictionary<string, IOpenApiSchema>();
 
         foreach (string propertyName in propertyNamesInOrder)
         {
-            if (fullSchema.Properties.TryGetValue(propertyName, out OpenApiSchema? schema))
+            if (fullSchema.Properties != null && fullSchema.Properties.TryGetValue(propertyName, out IOpenApiSchema? schema))
             {
                 propertiesInOrder.Add(propertyName, schema);
             }
         }
 
+        ConsistencyGuard.ThrowIf(fullSchema.Properties == null);
         ConsistencyGuard.ThrowIf(fullSchema.Properties.Count != propertiesInOrder.Count);
 
         fullSchema.Properties = propertiesInOrder;
     }
 
-    public static OpenApiSchema WrapInExtendedSchema(this OpenApiSchema source)
+    public static OpenApiSchema WrapInExtendedSchema(this IOpenApiSchema source)
     {
         ArgumentNullException.ThrowIfNull(source);
 
@@ -34,11 +36,11 @@ public static OpenApiSchema WrapInExtendedSchema(this OpenApiSchema source)
         };
     }
 
-    public static OpenApiSchema UnwrapLastExtendedSchema(this OpenApiSchema source)
+    public static IOpenApiSchema UnwrapLastExtendedSchema(this IOpenApiSchema source)
     {
         ArgumentNullException.ThrowIfNull(source);
 
-        if (source.AllOf is { Count: > 0 })
+        if (source is OpenApiSchema && source.AllOf is { Count: > 0 })
         {
             return source.AllOf.Last();
         }