Document type references: Backend implementation of endpoints and services #20300

Zeegaan · 2025-09-29T13:50:49Z

Notes

This is a feature, that aims to let the user know, if the document type is referenced anywhere, the most common use case is, when you go to delete a document type, you would like to know if it is used somewhere before deleting it, as it can have massive consequences.
This PR remedies that, by implemeting a service that covers 3 different uses:
- Referenced by documents, supply a document type key, and you will get back a list of all the document keys that is created from that document type
- Referenced by other document types, supply a document type key, and you will get back a list of all the document type keys, that inherit from that document type.
- Datatypes referincing that document type, supply a document type key (element), and it will return a list of all the data type keys, (blocklist, blockgrid & richtext data types) that references this doucment type (element type)

How to test

You can look at the integration tests created for inspiration.
For the first use case, create a document type (or multiple)
Create some content from this document type, keep a track of how many you create
- Call the service with the document type you created, and assert it returns the correct number and correct guids
For the second use case, create 2 document types, 1 inheriting from the other. ( again you can do multiple here)
- Call the service with the document type that is inherited FROM, assert it returns the correct number of document types and the GUIDS are correct
For the third and last use case, this time, start by creating a document type, but create it as an element.
- Create a document type, with a block list/blockgrid/richtext, that uses the element you've created
- Call the service with the element type key you've created, assert it returns the correct number and GUIDS

Copilot

Pull Request Overview

This PR implements a new feature to track document type references across the Umbraco CMS system. The implementation provides backend services and API endpoints to help users understand dependencies before deleting document types.

Implements service layer for tracking three types of document type references: documents using a document type, document types inheriting from another, and data types (block list/grid/rich text) referencing element types
Adds repository methods for querying document and content type relationships
Creates API controllers with pagination support for exposing reference information via REST endpoints

Reviewed Changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
ContentTypeReferenceServiceTests.cs	Integration tests covering all three reference scenarios with multiple block editor types
DocumentRepository.cs	Repository method to find documents by document type key using SQL joins
DataTypeRepository.cs	Repository method to find block editors referencing content types by parsing configurations
ContentTypeRepository.cs	Repository method to find child content types using composition relationships
IContentTypeReferenceService.cs	Service interface defining three async methods for getting references
ContentTypeReferenceService.cs	Service implementation coordinating repository calls within database scopes
IDocumentRepository.cs	Interface extension adding document reference query method
IDataTypeRepository.cs	Interface extension adding block editor reference query method
IContentTypeRepository.cs	Interface extension adding child content type query method
UmbracoBuilder.cs	Dependency injection registration for the new service
ReferencedByDocumentTypeDocumentTypeController.cs	API controller for document types that inherit from a given type
ReferencedByDocumentDocumentTypeController.cs	API controller for documents using a given document type
ReferencedByDataTypeDocumentTypeController.cs	API controller for data types referencing a given element type

tests/Umbraco.Tests.Integration/Umbraco.Core/Services/ContentTypeReferenceServiceTests.cs

src/Umbraco.Infrastructure/Persistence/Repositories/Implement/DocumentRepository.cs

src/Umbraco.Infrastructure/Persistence/Repositories/Implement/ContentTypeRepository.cs

src/Umbraco.Core/Services/IContentTypeReferenceService.cs

…DocumentRepository.cs Co-authored-by: Copilot <[email protected]>

…ContentTypeRepository.cs Co-authored-by: Copilot <[email protected]>

Co-authored-by: Copilot <[email protected]>

AndyButland

Looks really good @Zeegaan. I haven't done a thorough review with testing as I saw Kenn already had 👀on it, but have left a few small formatting suggestions and a question about whether the paging should be introduced on the methods where you return PagedModel but don't currently accept skip and take.

AndyButland · 2025-09-29T20:51:59Z

src/Umbraco.Core/Persistence/Repositories/IDocumentRepository.cs

    /// </summary>
    bool RecycleBinSmells();
+
+    PagedModel<Guid> GetReferencingDocumentsByDocumentTypeKey(Guid documentTypeKey) => throw new NotImplementedException();


Should this have the skip and take parameters? Maybe in practice it's fine to get all, but it feels a little odd to return PagedModel without them.

AndyButland · 2025-09-29T20:54:07Z

src/Umbraco.Core/Services/ContentTypeReferenceService.cs

+    {
+        using ICoreScope scope = _coreScopeProvider.CreateCoreScope();
+
+        PagedModel<Guid> keys = _contentTypeRepository.GetChildren(key);


Looks like this will get the inheriting document types - i.e. the children. But should it also get document types that are use the provided document type key as a composition?

What @AndyButland said. Also, it applies to all descendants, not just immediate children.

Historically we've "just" loaded all content types and handled these kind of reference detection/validation in memory, from the notion that there really isn't that many content types for it to be a problem. See for example GetAvailableCompositeContentTypes(), which is used to figure out applicable content types available for composition given certain filtering requirements. It expects allContentTypes.

AndyButland · 2025-09-29T20:54:47Z

src/Umbraco.Infrastructure/Persistence/Repositories/Implement/DataTypeRepository.cs

+            Constants.PropertyEditors.Aliases.BlockList,
+            Constants.PropertyEditors.Aliases.RichText,
+        };
+        // Get All contentTypes where isContainer (list view enabled) is set to true


Suggested change

// Get All contentTypes where isContainer (list view enabled) is set to true

// Get All contentTypes where isContainer (list view enabled) is set to true

AndyButland · 2025-09-29T20:55:09Z

src/Umbraco.Infrastructure/Persistence/Repositories/Implement/DataTypeRepository.cs

+            .From<DataTypeDto>()
+            .InnerJoin<NodeDto>()
+            .On<DataTypeDto, NodeDto>(left => left.NodeId, right => right.NodeId)
+            .WhereIn<DataTypeDto>(n => n.EditorAlias, blockEditorAliases );


Suggested change

.WhereIn<DataTypeDto>(n => n.EditorAlias, blockEditorAliases );

.WhereIn<DataTypeDto>(n => n.EditorAlias, blockEditorAliases);

AndyButland · 2025-09-29T20:57:40Z

src/Umbraco.Infrastructure/Persistence/Repositories/Implement/DataTypeRepository.cs

+                case Constants.PropertyEditors.Aliases.BlockGrid:
+                    BlockGridConfiguration? blockGridConfigurations = ConfigurationEditor.ConfigurationAs<BlockGridConfiguration>(dataType.ConfigurationObject);
+
+                    if(blockGridConfigurations is null)


Suggested change

if(blockGridConfigurations is null)

if (blockGridConfigurations is null)

kjac · 2025-09-30T06:58:25Z

src/Umbraco.Core/Persistence/Repositories/IContentTypeRepository.cs


    IEnumerable<int> GetAllContentTypeIds(string[] aliases);
+
+    PagedModel<Guid> GetChildren(Guid parentKey) => throw new NotImplementedException();


I don't think this method is necessary ref. the comments in ContentTypeReferenceService

kjac · 2025-09-30T06:59:37Z

src/Umbraco.Infrastructure/Persistence/Repositories/Implement/DataTypeRepository.cs

+            Constants.PropertyEditors.Aliases.BlockGrid,
+            Constants.PropertyEditors.Aliases.BlockList,
+            Constants.PropertyEditors.Aliases.RichText,


While this is true from a core perspective, it does not take into account that extensions might also reference content types. Specifically custom block editors will do, but in theory - any extension can utilize a content type.

kjac · 2025-09-30T08:16:18Z

src/Umbraco.Core/Services/ContentTypeReferenceService.cs

+        _dataTypeRepository = dataTypeRepository;
+    }
+
+    public Task<PagedModel<Guid>> GetReferencedDocumentKeysAsync(Guid key, CancellationToken cancellationToken, int skip, int take)


It doesn't look like skip and take is ever applied here.

kjac · 2025-09-30T08:21:11Z

src/Umbraco.Infrastructure/Persistence/Repositories/Implement/DocumentRepository.cs

+        Sql<ISqlContext> sqlContentTypeId = Sql()
+            .Select<ContentTypeDto>(x => x.NodeId)
+            .From<ContentTypeDto>()
+            .InnerJoin<NodeDto>()
+            .On<ContentTypeDto, NodeDto>((c, n) => c.NodeId == n.NodeId)
+            .Where<NodeDto>(x => x.UniqueId == documentTypeKey);


Is there any chance the IIdKeyMap service could be applied here?

Zeegaan and others added 9 commits September 22, 2025 21:44

Start implementing referenced by endpoints

81a86b8

Use reference by id model

49712fb

Implement is referenced by other document types

01b65a4

Add tests

d33f1d5

Implement the tracking for just blocklist

72a3865

Implement final functionality

b1e2af6

Add more tests

732ce46

Implement more tests

0472718

Fix breaking changes

bf6187c

Zeegaan marked this pull request as ready for review September 29, 2025 15:25

Copilot AI review requested due to automatic review settings September 29, 2025 15:25

Copilot AI reviewed Sep 29, 2025

View reviewed changes

Zeegaan and others added 3 commits September 29, 2025 18:43

Update src/Umbraco.Infrastructure/Persistence/Repositories/Implement/…

3d02437

…DocumentRepository.cs Co-authored-by: Copilot <[email protected]>

Update src/Umbraco.Infrastructure/Persistence/Repositories/Implement/…

8698222

…ContentTypeRepository.cs Co-authored-by: Copilot <[email protected]>

Update src/Umbraco.Core/Services/IContentTypeReferenceService.cs

2793856

Co-authored-by: Copilot <[email protected]>

AndyButland reviewed Sep 30, 2025

View reviewed changes

kjac reviewed Sep 30, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Document type references: Backend implementation of endpoints and services #20300

Document type references: Backend implementation of endpoints and services #20300

Uh oh!

Zeegaan commented Sep 29, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AndyButland left a comment

Uh oh!

AndyButland Sep 29, 2025

Uh oh!

AndyButland Sep 29, 2025

Uh oh!

kjac Sep 30, 2025

Uh oh!

AndyButland Sep 29, 2025

Uh oh!

AndyButland Sep 29, 2025

Uh oh!

AndyButland Sep 29, 2025

Uh oh!

kjac Sep 30, 2025

Uh oh!

kjac Sep 30, 2025

Uh oh!

kjac Sep 30, 2025

Uh oh!

kjac Sep 30, 2025

Uh oh!

Uh oh!

	// Get All contentTypes where isContainer (list view enabled) is set to true

	// Get All contentTypes where isContainer (list view enabled) is set to true

	.WhereIn<DataTypeDto>(n => n.EditorAlias, blockEditorAliases );
	.WhereIn<DataTypeDto>(n => n.EditorAlias, blockEditorAliases);

	if(blockGridConfigurations is null)
	if (blockGridConfigurations is null)


		IEnumerable<int> GetAllContentTypeIds(string[] aliases);

		PagedModel<Guid> GetChildren(Guid parentKey) => throw new NotImplementedException();

Document type references: Backend implementation of endpoints and services #20300

Are you sure you want to change the base?

Document type references: Backend implementation of endpoints and services #20300

Uh oh!

Conversation

Zeegaan commented Sep 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Notes

How to test

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AndyButland left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Zeegaan commented Sep 29, 2025 •

edited

Loading