Skip to content

Management API: SearchController improvements #13420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iOvergaard merged 6 commits into from
Nov 17, 2022
Merged

Management API: SearchController improvements #13420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ef40a8b
remove typo of double PagedViewModel in response
iOvergaard Nov 16, 2022
9eb9c4f
add providerProperties with custom formatter
iOvergaard Nov 16, 2022
639c3c9
use a more descriptive variable name
iOvergaard Nov 16, 2022
e7e8ccf
use a more descriptive variable name for property types
iOvergaard Nov 16, 2022
93ed9a0
generate new schema
iOvergaard Nov 17, 2022
4a50a7a
Merge remote-tracking branch 'origin/v11/dev' into v11/feature/manage…
Zeegaan Nov 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Umbraco.Cms.ManagementApi/Controllers/Search/SearcherSearchSearchController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public class SearcherSearchSearchController : SearchControllerBase

[HttpGet("searcher/{searcherName}/search")]
[MapToApiVersion("1.0")]
[ProducesResponseType(typeof(PagedViewModel<PagedViewModel<SearchResultViewModel>>), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(PagedViewModel<SearchResultViewModel>), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
public async Task<ActionResult<PagedViewModel<SearchResultViewModel>>> GetSearchResults(string searcherName, string? query, int skip, int take)
{
Expand Down
16 changes: 16 additions & 0 deletions src/Umbraco.Cms.ManagementApi/Factories/IndexViewModelFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,21 @@ public IndexViewModel Create(IIndex index)

Attempt<string?> isHealthy = indexDiag.IsHealthy();

var properties = new Dictionary<string, object?>();

foreach (var property in indexDiag.Metadata)
{
if (property.Value is null)
{
properties[property.Key] = null;
}
else
{
var propertyType = property.Value.GetType();
properties[property.Key] = propertyType.IsClass && !propertyType.IsArray ? property.Value?.ToString() : property.Value;
}
}

var indexerModel = new IndexViewModel
{
Name = index.Name,
Expand All @@ -45,6 +60,7 @@ public IndexViewModel Create(IIndex index)
SearcherName = index.Searcher.Name,
DocumentCount = indexDiag.GetDocumentCount(),
FieldCount = indexDiag.GetFieldNames().Count(),
ProviderProperties = properties,
};

return indexerModel;
Expand Down
38 changes: 15 additions & 23 deletions src/Umbraco.Cms.ManagementApi/OpenApi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2827,7 +2827,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedPaged"
"$ref": "#/components/schemas/PagedSearchResult"
}
}
}
Expand Down Expand Up @@ -4854,11 +4854,18 @@
"additionalProperties": false
},
"Index": {
"required": [
"canRebuild",
"documentCount",
"fieldCount",
"isHealthy",
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
"minLength": 1,
"type": "string"
},
"healthStatus": {
"type": "string",
Expand All @@ -4882,6 +4889,11 @@
"fieldCount": {
"type": "integer",
"format": "int32"
},
"providerProperties": {
"type": "object",
"additionalProperties": {},
"nullable": true
}
},
"additionalProperties": false
Expand Down Expand Up @@ -5754,26 +5766,6 @@
},
"additionalProperties": false
},
"PagedPaged": {
"required": [
"items",
"total"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PagedSearchResult"
}
}
},
"additionalProperties": false
},
"PagedRecycleBinItem": {
"required": [
"items",
Expand Down
11 changes: 10 additions & 1 deletion src/Umbraco.Cms.ManagementApi/ViewModels/Search/IndexViewModel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,27 @@
namespace Umbraco.Cms.ManagementApi.ViewModels.Search;
using System.ComponentModel.DataAnnotations;

namespace Umbraco.Cms.ManagementApi.ViewModels.Search;

public class IndexViewModel
{
[Required]
public string Name { get; init; } = null!;

public string? HealthStatus { get; init; }

[Required]
public bool IsHealthy => HealthStatus == "Healthy";

[Required]
public bool CanRebuild { get; init; }

public string SearcherName { get; init; } = null!;

[Required]
public long DocumentCount { get; init; }

[Required]
public int FieldCount { get; init; }

public IReadOnlyDictionary<string, object?>? ProviderProperties { get; init; }
}