Updated management API endpoint and model for data type references to align with that used for documents, media etc.

[AndyButland]

Prerequisites

• I have added steps to test this contribution in the description below

Handles internal task (HQ link).

Description

Although we already have a method for retrieving references for data types, it's not aligned from a management API endpoint and model perspective with that returned for document, media and members. We would like it to be so the front-end can handle in a consistent way.

This PR does that - obsoleting the existing method at the API and service layer and introducing new paged endpoints and service methods that return the appropriate models.

Note that under the hood these "relations" are quite different to the document, media and member ones that rely on Umbraco relations. These are derived from the Umbraco schema itself.

I decided not to do the paging at the database level and hence have reused existing repository methods. This was certainly simpler, as we would otherwise need to combine and page two already complicated database queries. And it seems reasonable given the number of relations here are relatively small compared to relations from documents, and the previous implementation wasn't paged.

Testing

Verify via the /umbraco/management/api/v1/data-type/{id}/referenced-by?skip={skip?&take={take} management API endpoint.

You should retrieve a response like the following:

{
  "total": 24,
  "items": [
    {
      "$type": "DocumentTypePropertyReferenceResponseModel",
      "documentType": {
        "id": "ee9c4aed-156a-499e-b467-8de4e4d02b34",
        "icon": "icon-map-location color-black",
        "alias": "contact",
        "name": "Contact"
      },
      "alias": "contactFormHeader",
      "id": "f46f193d-5e40-4d6a-ac94-4f77703d7fde",
      "name": "Contact Form Header"
    }
  ]
}

[Copilot]

Pull Request Overview

This PR updates the management API for data type references so that the response model aligns with those used for document, media, and member references.

• New paged endpoint for retrieving data type references.
• Introduces consolidated relation retrieval from both property and list view usages.
• Updates mapping definitions and controllers to support the new response models.

Reviewed Changes

Copilot reviewed 15 out of 16 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
tests/Umbraco.Tests.Integration/Umbraco.Infrastructure/Services/DataTypeServiceTests.cs	Added tests for the new GetPagedRelationsAsync functionality
tests/Umbraco.Tests.Common/Builders/MediaTypeBuilder.cs	Updated media type builder to include an icon value for media types
src/Umbraco.Core/Services/IDataTypeService.cs	Added new GetPagedRelationsAsync method and marked legacy methods as obsolete
src/Umbraco.Core/Services/DataTypeService.cs	Introduced overloaded constructors and implemented GetPagedRelationsAsync with consolidated usages
src/Umbraco.Core/Persistence/Repositories/IDataTypeRepository.cs	Minor removal of an empty line
src/Umbraco.Core/Models/RelationItemModel.cs	Added property NodeAlias to support the new response model
src/Umbraco.Core/Constants-ReferenceTypes.cs	Added a new class for reference types with updated properties
src/Umbraco.Cms.Api.Management/*	Updated view models, mapping definitions, and controllers to accommodate refactored relation responses
src/Umbraco.Cms.Api.Management/Controllers/DataType/ReferencesDataTypeController.cs	Marked outdated controller obsolete in favor of the new endpoint
src/Umbraco.Cms.Api.Management/Controllers/DataType/References/ReferencedByDataTypeController.cs	Introduced new controller for retrieving paged data type relations

Files not reviewed (1)

• src/Umbraco.Cms.Api.Management/OpenApi.json: Language not supported

Comments suppressed due to low confidence (2)

src/Umbraco.Core/Services/DataTypeService.cs:71

• The parameter name 'memberTypeRepositor' appears to be a typo; consider renaming it to 'memberTypeRepository' for clarity.

IMemberTypeRepository memberTypeRepositor,

src/Umbraco.Cms.Api.Management/Controllers/DataType/References/ReferencedByDataTypeController.cs:11

• The namespace contains 'DateType' which likely should be 'DataType' to stay consistent with the rest of the codebase.

namespace Umbraco.Cms.Api.Management.Controllers.DateType.References;

[madsrasmussen]

Speaking from a consumer perspective 😃

It looks really good and works as expected. One minor detail is the naming of the reference. I believe the correct name is "DocumentTypePropertyType," with the extra "Type" after "Property." I think what exists on a Document Type are Property Types, and what exists on the Document are properties. The same applies to the other Content Types 🤔

[AndyButland]

Thanks @madsrasmussen, agreed - I've updated the model and constants to align with this naming structure.

[madsrasmussen]

@AndyButland @nikolajlauridsen Everything looks good on the frontend. Feel free to merge when you're satisfied! 😄

I have opened a PR for the UI here #18914

[nikolajlauridsen]

Looks good, fixed a minor multiple enumeration thing