Skip to content

Management API: Return not found from request for content references when entity does not exist (closes #20997) #20999

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
Zeegaan merged 8 commits into from
Dec 2, 2025
Merged

Management API: Return not found from request for content references when entity does not exist (closes #20997) #20999

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
08ec4bc
Return not found when request for content references when entity does…
AndyButland Nov 28, 2025
174650c
Apply suggestions from code review
AndyButland Nov 28, 2025
b48bcc1
Move check for entity existence from controller to the service.
AndyButland Dec 1, 2025
211a663
Update OpenApi.json.
AndyButland Dec 1, 2025
8e0c060
Apply suggestions from code review
AndyButland Dec 1, 2025
9cdf7e6
Addressed points raised in code review.
AndyButland Dec 1, 2025
34b2d6f
Update OpenApi.json
AndyButland Dec 1, 2025
26525fd
Resolved breaking changes.
AndyButland Dec 1, 2025
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
29 changes: 28 additions & 1 deletion ...raco.Cms.Api.Management/Controllers/Document/References/ReferencedByDocumentController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
using Asp.Versioning;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.DependencyInjection;
using Umbraco.Cms.Api.Common.ViewModels.Pagination;
using Umbraco.Cms.Api.Management.Factories;
using Umbraco.Cms.Api.Management.ViewModels.TrackedReferences;
using Umbraco.Cms.Core.DependencyInjection;
using Umbraco.Cms.Core.Models;
using Umbraco.Cms.Core.Models.Entities;
using Umbraco.Cms.Core.Services;

namespace Umbraco.Cms.Api.Management.Controllers.Document.References;
Expand All @@ -14,11 +17,28 @@ public class ReferencedByDocumentController : DocumentControllerBase
{
private readonly ITrackedReferencesService _trackedReferencesService;
private readonly IRelationTypePresentationFactory _relationTypePresentationFactory;
private readonly IEntityService _entityService;

public ReferencedByDocumentController(ITrackedReferencesService trackedReferencesService, IRelationTypePresentationFactory relationTypePresentationFactory)
[Obsolete("Please use the constructor with all parameters. Scheduled for removal in Umbraco 19.")]
public ReferencedByDocumentController(
ITrackedReferencesService trackedReferencesService,
IRelationTypePresentationFactory relationTypePresentationFactory)
: this(
trackedReferencesService,
relationTypePresentationFactory,
StaticServiceProvider.Instance.GetRequiredService<IEntityService>())
{
}

[ActivatorUtilitiesConstructor]
public ReferencedByDocumentController(
ITrackedReferencesService trackedReferencesService,
IRelationTypePresentationFactory relationTypePresentationFactory,
IEntityService entityService)
{
_trackedReferencesService = trackedReferencesService;
_relationTypePresentationFactory = relationTypePresentationFactory;
_entityService = entityService;
}

/// <summary>
Expand All @@ -31,12 +51,19 @@ public ReferencedByDocumentController(ITrackedReferencesService trackedReference
[HttpGet("{id:guid}/referenced-by")]
[MapToApiVersion("1.0")]
[ProducesResponseType(typeof(PagedViewModel<IReferenceResponseModel>), StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public async Task<ActionResult<PagedViewModel<IReferenceResponseModel>>> ReferencedBy(
CancellationToken cancellationToken,
Guid id,
int skip = 0,
int take = 20)
{
IEntitySlim? entity = _entityService.Get(id, UmbracoObjectTypes.Document);
if (entity is null)
{
return NotFound();
}
Copy link
Member

@Zeegaan Zeegaan Dec 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I disagree on this approach, sorry 😢
I think this logic doesn't belong in the controller itself, but in the service.

I think we should update the ITrackedReferencesService
to instead adopt the Attempt<T> pattern, which most of our services have adopted at this point, and then it will return a failed attempt, if the IEntitySlim? entity = _entityService.Get(id, UmbracoObjectTypes.Document); returns null. I guess you also need to pass the ObjectType, but I don't see the problem in that.
We actually already inject the IEntityService in the service, but it's not used for now 🙈

Image

Copy link
Contributor Author

@AndyButland AndyButland Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to apologies, you are right in my view. I've refactored to implement this in the way you have suggested. Would you mind having another look please? Thanks.


PagedModel<RelationItemModel> relationItems = await _trackedReferencesService.GetPagedRelationsForItemAsync(id, skip, take, true);

var pagedViewModel = new PagedViewModel<IReferenceResponseModel>
Expand Down
29 changes: 28 additions & 1 deletion ...Api.Management/Controllers/Document/References/ReferencedDescendantsDocumentController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
using Asp.Versioning;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.DependencyInjection;
using Umbraco.Cms.Api.Common.ViewModels.Pagination;
using Umbraco.Cms.Api.Management.ViewModels;
using Umbraco.Cms.Core.DependencyInjection;
using Umbraco.Cms.Core.Mapping;
using Umbraco.Cms.Core.Models;
using Umbraco.Cms.Core.Models.Entities;
using Umbraco.Cms.Core.Services;

namespace Umbraco.Cms.Api.Management.Controllers.Document.References;
Expand All @@ -14,11 +17,28 @@ public class ReferencedDescendantsDocumentController : DocumentControllerBase
{
private readonly ITrackedReferencesService _trackedReferencesSkipTakeService;
private readonly IUmbracoMapper _umbracoMapper;
private readonly IEntityService _entityService;

public ReferencedDescendantsDocumentController(ITrackedReferencesService trackedReferencesSkipTakeService, IUmbracoMapper umbracoMapper)
[Obsolete("Please use the constructor with all parameters. Scheduled for removal in Umbraco 19.")]
public ReferencedDescendantsDocumentController(
ITrackedReferencesService trackedReferencesSkipTakeService,
IUmbracoMapper umbracoMapper)
: this(
trackedReferencesSkipTakeService,
umbracoMapper,
StaticServiceProvider.Instance.GetRequiredService<IEntityService>())
{
}

[ActivatorUtilitiesConstructor]
public ReferencedDescendantsDocumentController(
ITrackedReferencesService trackedReferencesSkipTakeService,
IUmbracoMapper umbracoMapper,
IEntityService entityService)
{
_trackedReferencesSkipTakeService = trackedReferencesSkipTakeService;
_umbracoMapper = umbracoMapper;
_entityService = entityService;
}

/// <summary>
Expand All @@ -32,12 +52,19 @@ public ReferencedDescendantsDocumentController(ITrackedReferencesService tracked
[HttpGet("{id:guid}/referenced-descendants")]
[MapToApiVersion("1.0")]
[ProducesResponseType(typeof(PagedViewModel<ReferenceByIdModel>), StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public async Task<ActionResult<PagedViewModel<ReferenceByIdModel>>> ReferencedDescendants(
CancellationToken cancellationToken,
Guid id,
int skip = 0,
int take = 20)
{
IEntitySlim? entity = _entityService.Get(id, UmbracoObjectTypes.Document);
if (entity is null)
{
return NotFound();
}

PagedModel<RelationItemModel> relationItems = await _trackedReferencesSkipTakeService.GetPagedDescendantsInReferencesAsync(id, skip, take, true);
var pagedViewModel = new PagedViewModel<ReferenceByIdModel>
{
Expand Down
28 changes: 27 additions & 1 deletion src/Umbraco.Cms.Api.Management/Controllers/Media/References/ReferencedByMediaController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
using Asp.Versioning;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.DependencyInjection;
using Umbraco.Cms.Api.Common.ViewModels.Pagination;
using Umbraco.Cms.Api.Management.Factories;
using Umbraco.Cms.Api.Management.ViewModels.TrackedReferences;
using Umbraco.Cms.Core.DependencyInjection;
using Umbraco.Cms.Core.Models;
using Umbraco.Cms.Core.Models.Entities;
using Umbraco.Cms.Core.Services;

namespace Umbraco.Cms.Api.Management.Controllers.Media.References;
Expand All @@ -14,11 +17,28 @@ public class ReferencedByMediaController : MediaControllerBase
{
private readonly ITrackedReferencesService _trackedReferencesService;
private readonly IRelationTypePresentationFactory _relationTypePresentationFactory;
private readonly IEntityService _entityService;

public ReferencedByMediaController(ITrackedReferencesService trackedReferencesService, IRelationTypePresentationFactory relationTypePresentationFactory)
[Obsolete("Please use the constructor with all parameters. Scheduled for removal in Umbraco 19.")]
public ReferencedByMediaController(
ITrackedReferencesService trackedReferencesService,
IRelationTypePresentationFactory relationTypePresentationFactory)
: this(
trackedReferencesService,
relationTypePresentationFactory,
StaticServiceProvider.Instance.GetRequiredService<IEntityService>())
{
}

[ActivatorUtilitiesConstructor]
public ReferencedByMediaController(
ITrackedReferencesService trackedReferencesService,
IRelationTypePresentationFactory relationTypePresentationFactory,
IEntityService entityService)
{
_trackedReferencesService = trackedReferencesService;
_relationTypePresentationFactory = relationTypePresentationFactory;
_entityService = entityService;
}

/// <summary>
Expand All @@ -37,6 +57,12 @@ public async Task<ActionResult<PagedViewModel<IReferenceResponseModel>>> Referen
int skip = 0,
int take = 20)
{
IEntitySlim? entity = _entityService.Get(id, UmbracoObjectTypes.Media);
if (entity is null)
{
return NotFound();
}

PagedModel<RelationItemModel> relationItems = await _trackedReferencesService.GetPagedRelationsForItemAsync(id, skip, take, true);

var pagedViewModel = new PagedViewModel<IReferenceResponseModel>
Expand Down
30 changes: 29 additions & 1 deletion ...o.Cms.Api.Management/Controllers/Media/References/ReferencedDescendantsMediaController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
using Asp.Versioning;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.DependencyInjection;
using Umbraco.Cms.Api.Common.ViewModels.Pagination;
using Umbraco.Cms.Api.Management.Factories;
using Umbraco.Cms.Api.Management.ViewModels;
using Umbraco.Cms.Core.DependencyInjection;
using Umbraco.Cms.Core.Mapping;
using Umbraco.Cms.Core.Models;
using Umbraco.Cms.Core.Models.Entities;
using Umbraco.Cms.Core.Services;

namespace Umbraco.Cms.Api.Management.Controllers.Media.References;
Expand All @@ -14,11 +18,28 @@ public class ReferencedDescendantsMediaController : MediaControllerBase
{
private readonly ITrackedReferencesService _trackedReferencesSkipTakeService;
private readonly IUmbracoMapper _umbracoMapper;
private readonly IEntityService _entityService;

public ReferencedDescendantsMediaController(ITrackedReferencesService trackedReferencesSkipTakeService, IUmbracoMapper umbracoMapper)
[Obsolete("Please use the constructor with all parameters. Scheduled for removal in Umbraco 19.")]
public ReferencedDescendantsMediaController(
ITrackedReferencesService trackedReferencesSkipTakeService,
IUmbracoMapper umbracoMapper)
: this(
trackedReferencesSkipTakeService,
umbracoMapper,
StaticServiceProvider.Instance.GetRequiredService<IEntityService>())
{
}

[ActivatorUtilitiesConstructor]
public ReferencedDescendantsMediaController(
ITrackedReferencesService trackedReferencesSkipTakeService,
IUmbracoMapper umbracoMapper,
IEntityService entityService)
{
_trackedReferencesSkipTakeService = trackedReferencesSkipTakeService;
_umbracoMapper = umbracoMapper;
_entityService = entityService;
}

/// <summary>
Expand All @@ -32,12 +53,19 @@ public ReferencedDescendantsMediaController(ITrackedReferencesService trackedRef
[HttpGet("{id:guid}/referenced-descendants")]
[MapToApiVersion("1.0")]
[ProducesResponseType(typeof(PagedViewModel<ReferenceByIdModel>), StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public async Task<ActionResult<PagedViewModel<ReferenceByIdModel>>> ReferencedDescendants(
CancellationToken cancellationToken,
Guid id,
int skip = 0,
int take = 20)
{
IEntitySlim? entity = _entityService.Get(id, UmbracoObjectTypes.Media);
if (entity is null)
{
return NotFound();
}

PagedModel<RelationItemModel> relationItems = await _trackedReferencesSkipTakeService.GetPagedDescendantsInReferencesAsync(id, skip, take, true);
var pagedViewModel = new PagedViewModel<ReferenceByIdModel>
{
Expand Down
29 changes: 28 additions & 1 deletion src/Umbraco.Cms.Api.Management/Controllers/Member/References/ReferencedByMemberController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
using Asp.Versioning;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.DependencyInjection;
using Umbraco.Cms.Api.Common.ViewModels.Pagination;
using Umbraco.Cms.Api.Management.Factories;
using Umbraco.Cms.Api.Management.ViewModels.TrackedReferences;
using Umbraco.Cms.Core.DependencyInjection;
using Umbraco.Cms.Core.Models;
using Umbraco.Cms.Core.Models.Entities;
using Umbraco.Cms.Core.Services;

namespace Umbraco.Cms.Api.Management.Controllers.Member.References;
Expand All @@ -14,11 +17,28 @@ public class ReferencedByMemberController : MemberControllerBase
{
private readonly ITrackedReferencesService _trackedReferencesService;
private readonly IRelationTypePresentationFactory _relationTypePresentationFactory;
private readonly IEntityService _entityService;

public ReferencedByMemberController(ITrackedReferencesService trackedReferencesService, IRelationTypePresentationFactory relationTypePresentationFactory)
[Obsolete("Please use the constructor with all parameters. Scheduled for removal in Umbraco 19.")]
public ReferencedByMemberController(
ITrackedReferencesService trackedReferencesService,
IRelationTypePresentationFactory relationTypePresentationFactory)
: this(
trackedReferencesService,
relationTypePresentationFactory,
StaticServiceProvider.Instance.GetRequiredService<IEntityService>())
{
}

[ActivatorUtilitiesConstructor]
public ReferencedByMemberController(
ITrackedReferencesService trackedReferencesService,
IRelationTypePresentationFactory relationTypePresentationFactory,
IEntityService entityService)
{
_trackedReferencesService = trackedReferencesService;
_relationTypePresentationFactory = relationTypePresentationFactory;
_entityService = entityService;
}

/// <summary>
Expand All @@ -31,12 +51,19 @@ public ReferencedByMemberController(ITrackedReferencesService trackedReferencesS
[HttpGet("{id:guid}/referenced-by")]
[MapToApiVersion("1.0")]
[ProducesResponseType(typeof(PagedViewModel<IReferenceResponseModel>), StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public async Task<ActionResult<PagedViewModel<IReferenceResponseModel>>> ReferencedBy(
CancellationToken cancellationToken,
Guid id,
int skip = 0,
int take = 20)
{
IEntitySlim? entity = _entityService.Get(id, UmbracoObjectTypes.Member);
if (entity is null)
{
return NotFound();
}

PagedModel<RelationItemModel> relationItems = await _trackedReferencesService.GetPagedRelationsForItemAsync(id, skip, take, true);

var pagedViewModel = new PagedViewModel<IReferenceResponseModel>
Expand Down
29 changes: 28 additions & 1 deletion ...Cms.Api.Management/Controllers/Member/References/ReferencedDescendantsMemberController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
using Asp.Versioning;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.DependencyInjection;
using Umbraco.Cms.Api.Common.ViewModels.Pagination;
using Umbraco.Cms.Api.Management.ViewModels;
using Umbraco.Cms.Core.DependencyInjection;
using Umbraco.Cms.Core.Mapping;
using Umbraco.Cms.Core.Models;
using Umbraco.Cms.Core.Models.Entities;
using Umbraco.Cms.Core.Services;

namespace Umbraco.Cms.Api.Management.Controllers.Member.References;
Expand All @@ -14,11 +17,28 @@ public class ReferencedDescendantsMemberController : MemberControllerBase
{
private readonly ITrackedReferencesService _trackedReferencesSkipTakeService;
private readonly IUmbracoMapper _umbracoMapper;
private readonly IEntityService _entityService;

public ReferencedDescendantsMemberController(ITrackedReferencesService trackedReferencesSkipTakeService, IUmbracoMapper umbracoMapper)
[Obsolete("Please use the constructor with all parameters. Scheduled for removal in Umbraco 19.")]
public ReferencedDescendantsMemberController(
ITrackedReferencesService trackedReferencesSkipTakeService,
IUmbracoMapper umbracoMapper)
: this(
trackedReferencesSkipTakeService,
umbracoMapper,
StaticServiceProvider.Instance.GetRequiredService<IEntityService>())
{
}

[ActivatorUtilitiesConstructor]
public ReferencedDescendantsMemberController(
ITrackedReferencesService trackedReferencesSkipTakeService,
IUmbracoMapper umbracoMapper,
IEntityService entityService)
{
_trackedReferencesSkipTakeService = trackedReferencesSkipTakeService;
_umbracoMapper = umbracoMapper;
_entityService = entityService;
}

/// <summary>
Expand All @@ -32,12 +52,19 @@ public ReferencedDescendantsMemberController(ITrackedReferencesService trackedRe
[HttpGet("{id:guid}/referenced-descendants")]
[MapToApiVersion("1.0")]
[ProducesResponseType(typeof(PagedViewModel<ReferenceByIdModel>), StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public async Task<ActionResult<PagedViewModel<ReferenceByIdModel>>> ReferencedDescendants(
CancellationToken cancellationToken,
Guid id,
int skip = 0,
int take = 20)
{
IEntitySlim? entity = _entityService.Get(id, UmbracoObjectTypes.Member);
if (entity is null)
{
return NotFound();
}

PagedModel<RelationItemModel> relationItems = await _trackedReferencesSkipTakeService.GetPagedDescendantsInReferencesAsync(id, skip, take, true);
var pagedViewModel = new PagedViewModel<ReferenceByIdModel>
{
Expand Down
Loading