adds support for OpenAPI 3.1 descriptions

CHANGELOG.md

@@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Added support for OpenAPI 3.1. [#3914](https://github.com/microsoft/kiota/issues/3914)
+
 ### Changed
 
 - Fixed mapping of Binary Types to array buffer in TypeScript. [#6124](https://github.com/microsoft/kiota/issues/6124)
@@ -35,7 +37,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Fixed a bug in the VS Code extension deeplink with the API Center extension [#6004](https://github.com/microsoft/kiota/issues/6004)
 - Drops Python 3.8 support by removing deprecated type aliases from generated code. [microsoft/kiota-python#349](https://github.com/microsoft/kiota-python/issues/349)
-- Removes superfluous inline imports in serializer methods in Python Generation. 
+- Removes superfluous inline imports in serializer methods in Python Generation.
 
 ## [1.22.2]
 
@@ -1570,5 +1572,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Initial GitHub release
-
-

src/Kiota.Builder/Configuration/LanguagesInformation.cs

@@ -1,31 +1,24 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using Microsoft.OpenApi.Any;
+using System.Text.Json.Nodes;
 using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Writers;
 
 namespace Kiota.Builder.Configuration;
 
 public class LanguagesInformation : Dictionary<string, LanguageInformation>, IOpenApiSerializable, ICloneable
 {
-    public void SerializeAsV2(IOpenApiWriter writer) => SerializeAsV3(writer);
-    public void SerializeAsV3(IOpenApiWriter writer)
+    public void SerializeAsV2(IOpenApiWriter writer) => SerializeAsV31(writer);
+    public void SerializeAsV3(IOpenApiWriter writer) => SerializeAsV31(writer);
+    public static LanguagesInformation Parse(JsonObject jsonNode)
     {
-        ArgumentNullException.ThrowIfNull(writer);
-        writer.WriteStartObject();
-        foreach (var entry in this.OrderBy(static x => x.Key, StringComparer.OrdinalIgnoreCase))
+        var extension = new LanguagesInformation();
+        foreach (var property in jsonNode.Where(static property => property.Value is JsonObject))
         {
-            writer.WriteRequiredObject(entry.Key, entry.Value, (w, x) => x.SerializeAsV3(w));
+            extension.Add(property.Key, LanguageInformation.Parse(property.Value!));
         }
-        writer.WriteEndObject();
-    }
-    public static LanguagesInformation Parse(IOpenApiAny source)
-    {
-        if (source is not OpenApiObject rawObject) throw new ArgumentOutOfRangeException(nameof(source));
-        var extension = new LanguagesInformation();
-        foreach (var property in rawObject)
-            extension.Add(property.Key, LanguageInformation.Parse(property.Value));
+
         return extension;
     }
 
@@ -36,4 +29,15 @@ public object Clone()
             result.Add(entry.Key, entry.Value);// records don't need to be cloned as they are immutable
         return result;
     }
+
+    public void SerializeAsV31(IOpenApiWriter writer)
+    {
+        ArgumentNullException.ThrowIfNull(writer);
+        writer.WriteStartObject();
+        foreach (var entry in this.OrderBy(static x => x.Key, StringComparer.OrdinalIgnoreCase))
+        {
+            writer.WriteRequiredObject(entry.Key, entry.Value, (w, x) => x.SerializeAsV3(w));
+        }
+        writer.WriteEndObject();
+    }
 }

src/Kiota.Builder/EqualityComparers/OpenApiSchemaReferenceComparer.cs

@@ -1,28 +1,30 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
-using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Models.Interfaces;
+using Microsoft.OpenApi.Models.References;
 
 namespace Kiota.Builder.EqualityComparers;
 
-internal class OpenApiSchemaReferenceComparer(StringComparer? stringComparer = null) : IEqualityComparer<OpenApiSchema>
+internal class OpenApiSchemaReferenceComparer(StringComparer? stringComparer = null) : IEqualityComparer<IOpenApiSchema>
 {
     private readonly StringComparer _stringComparer = stringComparer ?? StringComparer.OrdinalIgnoreCase;
-    public bool Equals(OpenApiSchema? x, OpenApiSchema? y)
+    public bool Equals(IOpenApiSchema? x, IOpenApiSchema? y)
     {
-        if (string.IsNullOrEmpty(x?.Reference?.Id) || string.IsNullOrEmpty(y?.Reference?.Id)) return object.Equals(x, y);
-        return _stringComparer.Equals(x.Reference.Id, y.Reference.Id);
+        if (x is not OpenApiSchemaReference xRef || y is not OpenApiSchemaReference yRef) return object.Equals(x, y);
+        return _stringComparer.Equals(xRef.Reference.Id, yRef.Reference.Id);
     }
-    public int GetHashCode([DisallowNull] OpenApiSchema obj)
+    public int GetHashCode([DisallowNull] IOpenApiSchema obj)
     {
+        if (obj is not OpenApiSchemaReference objRef) return obj.GetHashCode();
         var hash = new HashCode();
-        if (!string.IsNullOrEmpty(obj.Reference?.Id))
+        if (!string.IsNullOrEmpty(objRef.Reference?.Id))
         {
-            hash.Add(obj.Reference.Id, _stringComparer);
+            hash.Add(objRef.Reference.Id, _stringComparer);
         }
         else
         {
-            hash.Add(obj);
+            hash.Add(objRef);
         }
 
         return hash.ToHashCode();

src/Kiota.Builder/Extensions/OpenApiDeprecationExtensionExtensions.cs

@@ -3,6 +3,7 @@
 using Kiota.Builder.CodeDOM;
 using Microsoft.OpenApi.MicrosoftExtensions;
 using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Models.Interfaces;
 using Microsoft.OpenApi.Services;
 
 namespace Kiota.Builder.Extensions;
@@ -12,38 +13,36 @@ internal static DeprecationInformation ToDeprecationInformation(this OpenApiDepr
     {
         return new DeprecationInformation(value.Description.CleanupDescription().CleanupXMLString(), value.Date, value.RemovalDate, value.Version.CleanupDescription().CleanupXMLString(), true);
     }
-    internal static DeprecationInformation GetDeprecationInformation(this OpenApiSchema schema)
+    internal static DeprecationInformation GetDeprecationInformation(this IOpenApiSchema schema)
     {
         if (schema.Deprecated && schema.Extensions.TryGetValue(OpenApiDeprecationExtension.Name, out var deprecatedExtension) && deprecatedExtension is OpenApiDeprecationExtension deprecatedValue)
             return deprecatedValue.ToDeprecationInformation();
         return new(null, null, null, null, schema.Deprecated);
     }
-    internal static DeprecationInformation GetDeprecationInformation(this OpenApiParameter parameter)
+    internal static DeprecationInformation GetDeprecationInformation(this IOpenApiParameter parameter)
     {
         if (parameter.Deprecated && parameter.Extensions.TryGetValue(OpenApiDeprecationExtension.Name, out var deprecatedExtension) && deprecatedExtension is OpenApiDeprecationExtension deprecatedValue)
             return deprecatedValue.ToDeprecationInformation();
         else if (parameter.Schema != null && !parameter.Schema.IsReferencedSchema() && parameter.Schema.Deprecated)
             return parameter.Schema.GetDeprecationInformation();
-        else if (parameter.Content.Values.Select(static x => x.Schema).Where(static x => x != null && !x.IsReferencedSchema() && x.Deprecated).Select(static x => x.GetDeprecationInformation()).FirstOrDefault(static x => x.IsDeprecated) is DeprecationInformation contentDeprecationInformation)
+        else if (parameter.Content.Values.Select(static x => x.Schema).Where(static x => x != null && !x.IsReferencedSchema() && x.Deprecated).Select(static x => x!.GetDeprecationInformation()).FirstOrDefault(static x => x.IsDeprecated) is DeprecationInformation contentDeprecationInformation)
             return contentDeprecationInformation;
         return new(null, null, null, null, parameter.Deprecated);
     }
     internal static DeprecationInformation GetDeprecationInformation(this OpenApiOperation operation)
     {
-        if (operation.Deprecated && operation.Extensions.TryGetValue(OpenApiDeprecationExtension.Name, out var deprecatedExtension) && deprecatedExtension is OpenApiDeprecationExtension deprecatedValue)
+        if (operation.Deprecated && operation.Extensions is not null && operation.Extensions.TryGetValue(OpenApiDeprecationExtension.Name, out var deprecatedExtension) && deprecatedExtension is OpenApiDeprecationExtension deprecatedValue)
             return deprecatedValue.ToDeprecationInformation();
-        else if (operation.Responses.Values
+        else if (operation.Responses?.Values
                                 .SelectMany(static x => x.Content.Values)
                                 .Select(static x => x?.Schema)
                                 .OfType<OpenApiSchema>()
-                                .Where(static x => !x.IsReferencedSchema())
                                 .Select(static x => x.GetDeprecationInformation())
                                 .FirstOrDefault(static x => x.IsDeprecated) is DeprecationInformation responseDeprecationInformation)
             return responseDeprecationInformation;
         else if (operation.RequestBody?.Content.Values
                                             .Select(static x => x?.Schema)
                                             .OfType<OpenApiSchema>()
-                                            .Where(static x => !x.IsReferencedSchema())
                                             .Select(static x => x.GetDeprecationInformation())
                                             .FirstOrDefault(static x => x.IsDeprecated) is DeprecationInformation requestDeprecationInformation)
             return requestDeprecationInformation;

src/Kiota.Builder/Extensions/OpenApiDocumentExtensions.cs

@@ -4,6 +4,7 @@
 using System.Threading.Tasks;
 using Kiota.Builder.EqualityComparers;
 using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Models.References;
 
 namespace Kiota.Builder.Extensions;
 
@@ -19,7 +20,7 @@ internal static void InitializeInheritanceIndex(this OpenApiDocument openApiDocu
             {
                 inheritanceIndex.TryAdd(entry.Key, new(StringComparer.OrdinalIgnoreCase));
                 if (entry.Value.AllOf != null)
-                    foreach (var allOfEntry in entry.Value.AllOf.Where(static x => !string.IsNullOrEmpty(x.Reference?.Id)))
+                    foreach (var allOfEntry in entry.Value.AllOf.OfType<OpenApiSchemaReference>())
                     {
                         var dependents = inheritanceIndex.GetOrAdd(allOfEntry.Reference.Id, new ConcurrentDictionary<string, bool>(StringComparer.OrdinalIgnoreCase));
                         dependents.TryAdd(entry.Key, false);
@@ -31,7 +32,7 @@ internal static void InitializeInheritanceIndex(this OpenApiDocument openApiDocu
     {
         ArgumentNullException.ThrowIfNull(openApiDocument);
         var candidateUrl = openApiDocument.Servers
-                                        .GroupBy(static x => x, new OpenApiServerComparer()) //group by protocol relative urls
+                                        ?.GroupBy(static x => x, new OpenApiServerComparer()) //group by protocol relative urls
                                         .FirstOrDefault()
                                         ?.OrderByDescending(static x => x.Url, StringComparer.OrdinalIgnoreCase) // prefer https over http
                                         ?.FirstOrDefault()

src/Kiota.Builder/Extensions/OpenApiOperationExtensions.cs

@@ -3,6 +3,7 @@
 using System.Linq;
 using Kiota.Builder.Configuration;
 using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Models.Interfaces;
 
 namespace Kiota.Builder.Extensions;
 public static class OpenApiOperationExtensions
@@ -21,21 +22,22 @@
     /// <summary>
     /// cleans application/vnd.github.mercy-preview+json to application/json
     /// </summary>
-    internal static OpenApiSchema? GetResponseSchema(this OpenApiOperation operation, StructuredMimeTypesCollection structuredMimeTypes)
+    internal static IOpenApiSchema? GetResponseSchema(this OpenApiOperation operation, StructuredMimeTypesCollection structuredMimeTypes)
     {
         ArgumentNullException.ThrowIfNull(operation);
         // Return Schema that represents all the possible success responses!
         return operation.GetResponseSchemas(SuccessCodes, structuredMimeTypes)
                             .FirstOrDefault();
     }
-    internal static IEnumerable<OpenApiSchema> GetResponseSchemas(this OpenApiOperation operation, HashSet<string> successCodesToUse, StructuredMimeTypesCollection structuredMimeTypes)
+    internal static IEnumerable<IOpenApiSchema> GetResponseSchemas(this OpenApiOperation operation, HashSet<string> successCodesToUse, StructuredMimeTypesCollection structuredMimeTypes)
     {
+        if (operation.Responses is null) return [];
         // Return Schema that represents all the possible success responses!
         return operation.Responses.Where(r => successCodesToUse.Contains(r.Key))
                             .OrderBy(static x => x.Key, StringComparer.OrdinalIgnoreCase)
                             .SelectMany(re => re.Value.Content.GetValidSchemas(structuredMimeTypes));
     }
-    internal static OpenApiSchema? GetRequestSchema(this OpenApiOperation operation, StructuredMimeTypesCollection structuredMimeTypes)
+    internal static IOpenApiSchema? GetRequestSchema(this OpenApiOperation operation, StructuredMimeTypesCollection structuredMimeTypes)
     {
         ArgumentNullException.ThrowIfNull(operation);
         return operation.RequestBody?.Content
@@ -44,7 +46,7 @@
     private static readonly StructuredMimeTypesCollection multipartMimeTypes = new(["multipart/form-data"]);
     internal static bool IsMultipartFormDataSchema(this IDictionary<string, OpenApiMediaType> source, StructuredMimeTypesCollection structuredMimeTypes)
     {
-        return source.GetValidSchemas(structuredMimeTypes).FirstOrDefault() is OpenApiSchema schema &&
+        return source.GetValidSchemas(structuredMimeTypes).FirstOrDefault() is IOpenApiSchema schema &&
         source.GetValidSchemas(multipartMimeTypes).FirstOrDefault() == schema;
     }
     internal static bool IsMultipartTopMimeType(this IDictionary<string, OpenApiMediaType> source, StructuredMimeTypesCollection structuredMimeTypes)
@@ -56,7 +58,7 @@
         if (source.Count == 1 || !source.Keys.Where(static x => !multipartMimeTypes.Contains(x)).Any(structuredMimeTypes.Contains)) return true;
         return structuredMimeTypes.First() == multipartMimeTypes.First();
     }
-    internal static IEnumerable<OpenApiSchema> GetValidSchemas(this IDictionary<string, OpenApiMediaType> source, StructuredMimeTypesCollection structuredMimeTypes)
+    internal static IEnumerable<IOpenApiSchema> GetValidSchemas(this IDictionary<string, OpenApiMediaType> source, StructuredMimeTypesCollection structuredMimeTypes)
     {
         ArgumentNullException.ThrowIfNull(source);
         ArgumentNullException.ThrowIfNull(structuredMimeTypes);
@@ -67,9 +69,9 @@
                     .Select(static c => (Key: c.Key.Split(';', StringSplitOptions.RemoveEmptyEntries)[0], c.Value))
                     .Where(c => structuredMimeTypes.Contains(c.Key) || structuredMimeTypes.Contains(vendorSpecificCleanup(c.Key)))
                     .Select(static co => co.Value.Schema)
-                    .Where(static s => s is not null);
+                    .OfType<IOpenApiSchema>();
     }
-    internal static OpenApiSchema? GetResponseSchema(this OpenApiResponse response, StructuredMimeTypesCollection structuredMimeTypes)
+    internal static IOpenApiSchema? GetResponseSchema(this IOpenApiResponse response, StructuredMimeTypesCollection structuredMimeTypes)
     {
         ArgumentNullException.ThrowIfNull(response);
         return response.Content.GetValidSchemas(structuredMimeTypes).FirstOrDefault();