Merge branch 'v14/dev' into release/14.0

Author: iOvergaard

src/Umbraco.Cms.Api.Management/OpenApi/IOpenApiDiscriminator.cs renamed to src/Umbraco.Cms.Api.Common/OpenApi/IOpenApiDiscriminator.cs

@@ -1,4 +1,4 @@
-namespace Umbraco.Cms.Api.Management.OpenApi;
+namespace Umbraco.Cms.Api.Common.OpenApi;
 
 /// <summary>
 /// Marker interface that ensure the type have a "$type" discriminator in the open api schema.

src/Umbraco.Cms.Api.Common/OpenApi/SwaggerRouteTemplatePipelineFilter.cs

@@ -62,6 +62,10 @@ protected virtual void SwaggerUiConfiguration(
             swaggerUiOptions.SwaggerEndpoint($"{name}/swagger.json", $"{apiInfo.Title}");
         }
 
+        // Add custom configuration from https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/
+        swaggerUiOptions.ConfigObject.PersistAuthorization = true; // persists authorization data so it would not be lost on browser close/refresh
+        swaggerUiOptions.ConfigObject.Filter = string.Empty; // Enable the filter with an empty string as default filter.
+
         swaggerUiOptions.OAuthClientId(Constants.OAuthClientIds.Swagger);
         swaggerUiOptions.OAuthUsePkce();
     }

src/Umbraco.Cms.Api.Common/Serialization/IUmbracoJsonTypeInfoResolver.cs

@@ -5,4 +5,6 @@ namespace Umbraco.Cms.Api.Common.Serialization;
 public interface IUmbracoJsonTypeInfoResolver : IJsonTypeInfoResolver
 {
     IEnumerable<Type> FindSubTypes(Type type);
+
+    string? GetTypeDiscriminatorValue(Type type);
 }

src/Umbraco.Cms.Api.Common/Serialization/UmbracoJsonTypeInfoResolver.cs

@@ -1,7 +1,10 @@
 using System.Collections.Concurrent;
 using System.Text.Json;
+using System.Text.Json.Serialization;
 using System.Text.Json.Serialization.Metadata;
+using Umbraco.Cms.Api.Common.OpenApi;
 using Umbraco.Cms.Core.Composing;
+using Umbraco.Extensions;
 
 namespace Umbraco.Cms.Api.Common.Serialization;
 
@@ -15,6 +18,14 @@ public UmbracoJsonTypeInfoResolver(ITypeFinder typeFinder)
 
     public IEnumerable<Type> FindSubTypes(Type type)
     {
+        JsonDerivedTypeAttribute[] explicitJsonDerivedTypes = type
+            .GetCustomAttributes<JsonDerivedTypeAttribute>(false)
+            .ToArray();
+        if (explicitJsonDerivedTypes.Any())
+        {
+            return explicitJsonDerivedTypes.Select(a => a.DerivedType);
+        }
+
         if (type.IsInterface is false)
         {
             // IMPORTANT: do NOT return an empty enumerable here. it will cause nullability to fail on reference
@@ -33,6 +44,24 @@ public IEnumerable<Type> FindSubTypes(Type type)
         return result;
     }
 
+    public string? GetTypeDiscriminatorValue(Type type)
+    {
+        JsonDerivedTypeAttribute? jsonDerivedTypeAttribute = type
+            .GetBaseTypes(false)
+            .WhereNotNull()
+            .SelectMany(baseType => baseType.GetCustomAttributes<JsonDerivedTypeAttribute>(false))
+            .FirstOrDefault(attr => attr.DerivedType == type);
+
+        if (jsonDerivedTypeAttribute is not null)
+        {
+            // IMPORTANT: do NOT perform fallback to type.Name here - it will work for the schema generation,
+            //            but not for the actual serialization, and then it's only going to cause confusion.
+            return jsonDerivedTypeAttribute.TypeDiscriminator?.ToString();
+        }
+
+        return typeof(IOpenApiDiscriminator).IsAssignableFrom(type) ? type.Name : null;
+    }
+
     public override JsonTypeInfo GetTypeInfo(Type type, JsonSerializerOptions options)
     {
         JsonTypeInfo result = base.GetTypeInfo(type, options);

src/Umbraco.Cms.Api.Management/Configuration/ConfigureUmbracoManagementApiSwaggerGenOptions.cs

@@ -2,6 +2,7 @@
 using Microsoft.Extensions.Options;
 using Microsoft.OpenApi.Models;
 using Swashbuckle.AspNetCore.SwaggerGen;
+using Umbraco.Cms.Api.Common.OpenApi;
 using Umbraco.Cms.Api.Common.Serialization;
 using Umbraco.Cms.Api.Management.DependencyInjection;
 using Umbraco.Cms.Api.Management.OpenApi;
@@ -34,8 +35,8 @@ public void Configure(SwaggerGenOptions swaggerGenOptions)
         swaggerGenOptions.UseOneOfForPolymorphism();
 
         // Ensure all types that implements the IOpenApiDiscriminator have a $type property in the OpenApi schema with the default value (The class name) that is expected by the server
-        swaggerGenOptions.SelectDiscriminatorNameUsing(type => typeof(IOpenApiDiscriminator).IsAssignableFrom(type) ? "$type" : null);
-        swaggerGenOptions.SelectDiscriminatorValueUsing(type => typeof(IOpenApiDiscriminator).IsAssignableFrom(type) ? type.Name : null);
+        swaggerGenOptions.SelectDiscriminatorNameUsing(type => _umbracoJsonTypeInfoResolver.GetTypeDiscriminatorValue(type) is not null ? "$type" : null);
+        swaggerGenOptions.SelectDiscriminatorValueUsing(_umbracoJsonTypeInfoResolver.GetTypeDiscriminatorValue);
 
 
         swaggerGenOptions.AddSecurityDefinition(

src/Umbraco.Cms.Api.Management/Controllers/DataType/Item/ItemDatatypeItemController.cs

@@ -27,6 +27,11 @@ public async Task<ActionResult> Item(
         CancellationToken cancellationToken,
         [FromQuery(Name = "id")] HashSet<Guid> ids)
     {
+        if (ids.Count is 0)
+        {
+            return Ok(Enumerable.Empty<DataTypeItemResponseModel>());
+        }
+
         var dataTypes = new List<IDataType>();
         foreach (Guid id in ids)
         {

src/Umbraco.Cms.Api.Management/Controllers/Dictionary/Item/ItemDictionaryItemController.cs

@@ -27,6 +27,11 @@ public async Task<ActionResult> Item(
         CancellationToken cancellationToken,
         [FromQuery(Name = "id")] HashSet<Guid> ids)
     {
+        if (ids.Count is 0)
+        {
+            return Ok(Enumerable.Empty<DictionaryItemItemResponseModel>());
+        }
+
         IEnumerable<IDictionaryItem> dictionaryItems = await _dictionaryItemService.GetManyAsync(ids.ToArray());
 
         List<DictionaryItemItemResponseModel> responseModels = _mapper.MapEnumerable<IDictionaryItem, DictionaryItemItemResponseModel>(dictionaryItems);

src/Umbraco.Cms.Api.Management/Controllers/Document/Item/ItemDocumentItemController.cs

@@ -28,6 +28,11 @@ public async Task<ActionResult> Item(
         CancellationToken cancellationToken,
         [FromQuery(Name = "id")] HashSet<Guid> ids)
     {
+        if (ids.Count is 0)
+        {
+            return Ok(Enumerable.Empty<DocumentItemResponseModel>());
+        }
+
         IEnumerable<IDocumentEntitySlim> documents = _entityService
             .GetAll(UmbracoObjectTypes.Document, ids.ToArray())
             .OfType<IDocumentEntitySlim>();

src/Umbraco.Cms.Api.Management/Controllers/DocumentType/Item/ItemDocumentTypeItemController.cs

@@ -27,6 +27,11 @@ public async Task<IActionResult> Item(
         CancellationToken cancellationToken,
         [FromQuery(Name = "id")] HashSet<Guid> ids)
     {
+        if (ids.Count is 0)
+        {
+            return Ok(Enumerable.Empty<DocumentTypeItemResponseModel>());
+        }
+
         IEnumerable<IContentType> contentTypes = _contentTypeService.GetAll(ids);
         List<DocumentTypeItemResponseModel> responseModels = _mapper.MapEnumerable<IContentType, DocumentTypeItemResponseModel>(contentTypes);
         return await Task.FromResult(Ok(responseModels));

src/Umbraco.Cms.Api.Management/Controllers/Language/Item/ItemsLanguageEntityController.cs renamed to src/Umbraco.Cms.Api.Management/Controllers/Language/Item/ItemLanguageItemController.cs

@@ -9,12 +9,12 @@
 namespace Umbraco.Cms.Api.Management.Controllers.Language.Item;
 
 [ApiVersion("1.0")]
-public class ItemsLanguageEntityController : LanguageEntityControllerBase
+public class ItemLanguageItemController : LanguageItemControllerBase
 {
     private readonly ILanguageService _languageService;
     private readonly IUmbracoMapper _mapper;
 
-    public ItemsLanguageEntityController(ILanguageService languageService, IUmbracoMapper mapper)
+    public ItemLanguageItemController(ILanguageService languageService, IUmbracoMapper mapper)
     {
         _languageService = languageService;
         _mapper = mapper;
@@ -23,10 +23,15 @@ public ItemsLanguageEntityController(ILanguageService languageService, IUmbracoM
     [HttpGet]
     [MapToApiVersion("1.0")]
     [ProducesResponseType(typeof(IEnumerable<LanguageItemResponseModel>), StatusCodes.Status200OK)]
-    public async Task<ActionResult> Items(
+    public async Task<IActionResult> Item(
         CancellationToken cancellationToken,
         [FromQuery(Name = "isoCode")] HashSet<string> isoCodes)
     {
+        if (isoCodes.Count is 0)
+        {
+            return Ok(Enumerable.Empty<LanguageItemResponseModel>());
+        }
+
         IEnumerable<ILanguage> languages = await _languageService.GetMultipleAsync(isoCodes);
         List<LanguageItemResponseModel> entityResponseModels = _mapper.MapEnumerable<ILanguage, LanguageItemResponseModel>(languages);
         return Ok(entityResponseModels);