Make Examine API more REST-ish (#13198)

* Make Examine API more REST-ish

* Undo bad renaming

* Move search endpoint under "searchers" route

* Update schema to match new API definition

* Update OpenAPI schema after merge

* Remove "examine" prefixes and change API route from "examine" to "search"

* Update OpenAPI json schema

Author: kjac

src/Umbraco.Cms.ManagementApi/Controllers/ExamineManagement/ExamineManagementControllerBase.cs

@@ -2,21 +2,21 @@
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using Umbraco.Cms.ManagementApi.Factories;
-using Umbraco.Cms.ManagementApi.ViewModels.ExamineManagement;
+using Umbraco.Cms.ManagementApi.ViewModels.Search;
 
-namespace Umbraco.Cms.ManagementApi.Controllers.ExamineManagement;
+namespace Umbraco.Cms.ManagementApi.Controllers.Search;
 
 [ApiVersion("1.0")]
-public class IndexExamineManagementController : ExamineManagementControllerBase
+public class IndexDetailsSearchController : SearchControllerBase
 {
-    private readonly IExamineIndexViewModelFactory _examineIndexViewModelFactory;
+    private readonly IIndexViewModelFactory _indexViewModelFactory;
     private readonly IExamineManager _examineManager;
 
-    public IndexExamineManagementController(
-        IExamineIndexViewModelFactory examineIndexViewModelFactory,
+    public IndexDetailsSearchController(
+        IIndexViewModelFactory indexViewModelFactory,
         IExamineManager examineManager)
     {
-        _examineIndexViewModelFactory = examineIndexViewModelFactory;
+        _indexViewModelFactory = indexViewModelFactory;
         _examineManager = examineManager;
     }
 
@@ -29,15 +29,15 @@ public IndexExamineManagementController(
     ///     This is kind of rudimentary since there's no way we can know that the index has rebuilt, we
     ///     have a listener for the index op complete so we'll just check if that key is no longer there in the runtime cache
     /// </remarks>
-    [HttpGet("index")]
+    [HttpGet("index/{indexName}")]
     [MapToApiVersion("1.0")]
     [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
-    [ProducesResponseType(typeof(ExamineIndexViewModel), StatusCodes.Status200OK)]
-    public async Task<ActionResult<ExamineIndexViewModel?>> Index(string indexName)
+    [ProducesResponseType(typeof(IndexViewModel), StatusCodes.Status200OK)]
+    public async Task<ActionResult<IndexViewModel?>> Index(string indexName)
     {
         if (_examineManager.TryGetIndex(indexName, out IIndex? index))
         {
-            return await Task.FromResult(_examineIndexViewModelFactory.Create(index!));
+            return await Task.FromResult(_indexViewModelFactory.Create(index!));
         }
 
         var invalidModelProblem = new ProblemDetails

src/Umbraco.Cms.ManagementApi/Controllers/ExamineManagement/IndexesExamineManagementController.cs

@@ -0,0 +1,41 @@
+using Examine;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using Umbraco.Cms.ManagementApi.Factories;
+using Umbraco.Cms.ManagementApi.ViewModels.Pagination;
+using Umbraco.Cms.ManagementApi.ViewModels.Search;
+using Umbraco.Extensions;
+
+namespace Umbraco.Cms.ManagementApi.Controllers.Search;
+
+[ApiVersion("1.0")]
+public class IndexListSearchController : SearchControllerBase
+{
+    private readonly IExamineManager _examineManager;
+    private readonly IIndexViewModelFactory _indexViewModelFactory;
+
+    public IndexListSearchController(
+        IExamineManager examineManager,
+        IIndexViewModelFactory indexViewModelFactory)
+    {
+        _examineManager = examineManager;
+        _indexViewModelFactory = indexViewModelFactory;
+    }
+
+    /// <summary>
+    ///     Get the details for indexers
+    /// </summary>
+    /// <returns></returns>
+    [HttpGet("index")]
+    [MapToApiVersion("1.0")]
+    [ProducesResponseType(typeof(PagedViewModel<IndexViewModel>), StatusCodes.Status200OK)]
+    public async Task<PagedViewModel<IndexViewModel>> Indexes(int skip, int take)
+    {
+        IndexViewModel[] indexes = _examineManager.Indexes
+            .Select(_indexViewModelFactory.Create)
+            .OrderBy(indexModel => indexModel.Name.TrimEnd("Indexer")).ToArray();
+
+        var viewModel = new PagedViewModel<IndexViewModel> { Items = indexes.Skip(skip).Take(take), Total = indexes.Length };
+        return viewModel;
+    }
+}

src/Umbraco.Cms.ManagementApi/Controllers/ExamineManagement/IndexExamineManagementController.cs renamed to src/Umbraco.Cms.ManagementApi/Controllers/Search/IndexDetailsExamineController.cs

@@ -5,17 +5,17 @@
 using Umbraco.Cms.Infrastructure.Examine;
 using Umbraco.New.Cms.Infrastructure.Services;
 
-namespace Umbraco.Cms.ManagementApi.Controllers.ExamineManagement;
+namespace Umbraco.Cms.ManagementApi.Controllers.Search;
 
 [ApiVersion("1.0")]
-public class RebuildExamineManagementController : ExamineManagementControllerBase
+public class IndexRebuildSearchController : SearchControllerBase
 {
-    private readonly ILogger<RebuildExamineManagementController> _logger;
+    private readonly ILogger<IndexRebuildSearchController> _logger;
     private readonly IIndexingRebuilderService _indexingRebuilderService;
     private readonly IExamineManager _examineManager;
 
-    public RebuildExamineManagementController(
-        ILogger<RebuildExamineManagementController> logger,
+    public IndexRebuildSearchController(
+        ILogger<IndexRebuildSearchController> logger,
         IIndexingRebuilderService indexingRebuilderService,
         IExamineManager examineManager)
     {
@@ -29,7 +29,7 @@ public RebuildExamineManagementController(
     /// </summary>
     /// <param name="indexName"></param>
     /// <returns></returns>
-    [HttpPost("rebuild")]
+    [HttpPost("index/{indexName}/rebuild")]
     [MapToApiVersion("1.0")]
     [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
     [ProducesResponseType(typeof(OkResult), StatusCodes.Status200OK)]

src/Umbraco.Cms.ManagementApi/Controllers/Search/IndexListExamineController.cs

@@ -0,0 +1,12 @@
+using Microsoft.AspNetCore.Mvc;
+using NSwag.Annotations;
+using Umbraco.New.Cms.Web.Common.Routing;
+
+namespace Umbraco.Cms.ManagementApi.Controllers.Search;
+
+[ApiController]
+[VersionedApiBackOfficeRoute("search")]
+[OpenApiTag("Search")]
+public class SearchControllerBase : ManagementApiControllerBase
+{
+}

src/Umbraco.Cms.ManagementApi/Controllers/ExamineManagement/RebuildExamineManagementController.cs renamed to src/Umbraco.Cms.ManagementApi/Controllers/Search/IndexRebuildSearchController.cs

@@ -1,25 +1,24 @@
 using Examine;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
-using Umbraco.Cms.Infrastructure.Examine;
-using Umbraco.Cms.ManagementApi.ViewModels.ExamineManagement;
 using Umbraco.Cms.ManagementApi.ViewModels.Pagination;
+using Umbraco.Cms.ManagementApi.ViewModels.Search;
 using Umbraco.Extensions;
 
-namespace Umbraco.Cms.ManagementApi.Controllers.ExamineManagement;
+namespace Umbraco.Cms.ManagementApi.Controllers.Search;
 
 [ApiVersion("1.0")]
-public class SearchersExamineManagementController : ExamineManagementControllerBase
+public class SearcherListSearchController : SearchControllerBase
 {
     private readonly IExamineManager _examineManager;
 
-    public SearchersExamineManagementController(IExamineManager examineManager) => _examineManager = examineManager;
+    public SearcherListSearchController(IExamineManager examineManager) => _examineManager = examineManager;
 
     /// <summary>
     ///     Get the details for searchers
     /// </summary>
     /// <returns></returns>
-    [HttpGet("searchers")]
+    [HttpGet("searcher")]
     [MapToApiVersion("1.0")]
     [ProducesResponseType(typeof(PagedViewModel<SearcherViewModel>), StatusCodes.Status200OK)]
     public async Task<ActionResult<PagedViewModel<SearcherViewModel>>> Searchers(int skip, int take)

src/Umbraco.Cms.ManagementApi/Controllers/Search/SearchControllerBase.cs

@@ -4,20 +4,20 @@
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using Umbraco.Cms.ManagementApi.Services;
-using Umbraco.Cms.ManagementApi.ViewModels.ExamineManagement;
 using Umbraco.Cms.ManagementApi.ViewModels.Pagination;
+using Umbraco.Cms.ManagementApi.ViewModels.Search;
 using Umbraco.Extensions;
 
-namespace Umbraco.Cms.ManagementApi.Controllers.ExamineManagement;
+namespace Umbraco.Cms.ManagementApi.Controllers.Search;
 
 [ApiVersion("1.0")]
-public class SearchExamineManagementController : ExamineManagementControllerBase
+public class SearcherSearchSearchController : SearchControllerBase
 {
     private readonly IExamineManagerService _examineManagerService;
 
-    public SearchExamineManagementController(IExamineManagerService examineManagerService) => _examineManagerService = examineManagerService;
+    public SearcherSearchSearchController(IExamineManagerService examineManagerService) => _examineManagerService = examineManagerService;
 
-    [HttpGet("search")]
+    [HttpGet("searcher/{searcherName}/search")]
     [MapToApiVersion("1.0")]
     [ProducesResponseType(typeof(PagedViewModel<PagedViewModel<SearchResultViewModel>>), StatusCodes.Status200OK)]
     [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]

src/Umbraco.Cms.ManagementApi/Controllers/ExamineManagement/SearchersExamineManagementController.cs renamed to src/Umbraco.Cms.ManagementApi/Controllers/Search/SearcherListSearchController.cs

@@ -7,9 +7,9 @@
 
 namespace Umbraco.Cms.ManagementApi.DependencyInjection;
 
-public static class ExamineManagementBuilderExtensions
+public static class SearchManagementBuilderExtensions
 {
-    internal static IUmbracoBuilder AddExamineManagement(this IUmbracoBuilder builder)
+    internal static IUmbracoBuilder AddSearchManagement(this IUmbracoBuilder builder)
     {
         // Add examine service
         builder.Services.AddTransient<IExamineManagerService, ExamineManagerService>();
@@ -18,7 +18,7 @@ internal static IUmbracoBuilder AddExamineManagement(this IUmbracoBuilder builde
         // Add factories
         builder.Services.AddTransient<IIndexDiagnosticsFactory, IndexDiagnosticsFactory>();
         builder.Services.AddTransient<IIndexRebuilder, ExamineIndexRebuilder>();
-        builder.Services.AddTransient<IExamineIndexViewModelFactory, ExamineIndexViewModelFactory>();
+        builder.Services.AddTransient<IIndexViewModelFactory, IndexViewModelFactory>();
         return builder;
     }
 }