Refactor OpenAPI extensions as "links" nested property instead of array to allow future extensions

Author: commonsensesoftware

src/AspNetCore/WebApi/src/Asp.Versioning.OpenApi/Transformers/ApiExplorerTransformer.cs

@@ -301,8 +301,11 @@ private void AddLinkExtensions( OpenApiDocument document, ApiVersionDescription
 
         if ( array.Count > 0 )
         {
+            var obj = new JsonObject();
             var extensions = document.Extensions ??= new Dictionary<string, IOpenApiExtension>();
-            extensions[ExtensionName] = new JsonNodeExtension( array );
+
+            obj["links"] = array;
+            extensions[ExtensionName] = new JsonNodeExtension( obj );
         }
     }
 
@@ -347,7 +350,7 @@ protected virtual JsonObject ToJson( LinkHeaderValue link )
 
         if ( link.Languages.Count > 0 )
         {
-            obj["lang"] = new JsonArray( link.Languages.Select( l => JsonNode.Parse( l.ToString() ) ).ToArray() );
+            obj["lang"] = new JsonArray( [.. link.Languages.Select( l => JsonNode.Parse( l.ToString() ) )] );
         }
 
         foreach ( var (key, value) in link.Extensions )

src/AspNetCore/WebApi/test/Asp.Versioning.OpenApi.Tests/Content/v1-minimal.json

@@ -70,18 +70,20 @@
       "name": "Test"
     }
   ],
-  "x-api-versioning": [
-    {
-      "title": "Version Deprecation Policy",
-      "type": "text/html",
-      "rel": "deprecation",
-      "url": "http://my.api.com/policies/versions/deprecated.html"
-    },
-    {
-      "title": "Version Sunset Policy",
-      "type": "text/html",
-      "rel": "sunset",
-      "url": "http://my.api.com/policies/versions/sunset.html"
-    }
-  ]
+  "x-api-versioning": {
+    "links": [
+      {
+        "title": "Version Deprecation Policy",
+        "type": "text/html",
+        "rel": "deprecation",
+        "url": "http://my.api.com/policies/versions/deprecated.html"
+      },
+      {
+        "title": "Version Sunset Policy",
+        "type": "text/html",
+        "rel": "sunset",
+        "url": "http://my.api.com/policies/versions/sunset.html"
+      }
+    ]
+  }
 }

src/AspNetCore/WebApi/test/Asp.Versioning.OpenApi.Tests/Content/v1-mixed.json

@@ -142,18 +142,20 @@
       "name": "Test"
     }
   ],
-  "x-api-versioning": [
-    {
-      "title": "Version Deprecation Policy",
-      "type": "text/html",
-      "rel": "deprecation",
-      "url": "http://my.api.com/policies/versions/deprecated.html"
-    },
-    {
-      "title": "Version Sunset Policy",
-      "type": "text/html",
-      "rel": "sunset",
-      "url": "http://my.api.com/policies/versions/sunset.html"
-    }
-  ]
+  "x-api-versioning": {
+    "links": [
+      {
+        "title": "Version Deprecation Policy",
+        "type": "text/html",
+        "rel": "deprecation",
+        "url": "http://my.api.com/policies/versions/deprecated.html"
+      },
+      {
+        "title": "Version Sunset Policy",
+        "type": "text/html",
+        "rel": "sunset",
+        "url": "http://my.api.com/policies/versions/sunset.html"
+      }
+    ]
+  }
 }

src/AspNetCore/WebApi/test/Asp.Versioning.OpenApi.Tests/Content/v1.json

@@ -89,18 +89,20 @@
       "name": "Test"
     }
   ],
-  "x-api-versioning": [
-    {
-      "title": "Version Deprecation Policy",
-      "type": "text/html",
-      "rel": "deprecation",
-      "url": "http://my.api.com/policies/versions/deprecated.html"
-    },
-    {
-      "title": "Version Sunset Policy",
-      "type": "text/html",
-      "rel": "sunset",
-      "url": "http://my.api.com/policies/versions/sunset.html"
-    }
-  ]
+  "x-api-versioning": {
+    "links": [
+      {
+        "title": "Version Deprecation Policy",
+        "type": "text/html",
+        "rel": "deprecation",
+        "url": "http://my.api.com/policies/versions/deprecated.html"
+      },
+      {
+        "title": "Version Sunset Policy",
+        "type": "text/html",
+        "rel": "sunset",
+        "url": "http://my.api.com/policies/versions/sunset.html"
+      }
+    ]
+  }
 }