feat(api)!: update entity output for having relations grouped by brandPittCode · Pull Request #90 · Decathlon/internal-developer-platform

brandPittCode · 2026-07-08T12:18:39Z

PR Description

What this PR Provides

This pull request introduces a unified relations API for entities, combining both outbound and inbound relations into a single relations field in the API response. It also enriches relation summaries with template identifiers, allowing clients to distinguish entity types without extra queries. The changes affect the domain model, persistence, API mapping logic, and integration tests.

API & Data Model Improvements:

The relations field in API responses now contains both outbound and inbound relations, with each related entity summary including a template_identifier. The previous relations_as_target field is removed from responses.
The RelationAsTargetSummary model now includes a sourceTemplateIdentifier field, and the corresponding database query and mapping logic are updated to populate this field.

Backend Logic Refactoring:

The API mapping layer (EntityDtoOutMapper) is refactored to build a unified relations map, merging outbound and inbound relations under the same key and including template identifiers in related entity summaries. Obsolete mapping methods are removed

Test and Documentation Updates:

Integration test fixtures are updated to reflect the new unified relations structure and the inclusion of template identifiers.

These changes provide a more consistent and informative API for consumers, simplify relation handling, and enhance frontend capabilities.

Review

The reviewer must double-check these points:

The reviewer has tested the feature
The reviewer has reviewed the implementation of the feature
The documentation has been updated
The feature implementation respects the Technical Doc / ADR previously produced
The Pull Request title has a ! after the type/scope to identify the breaking
change in the release note and ensure we will release a major version.

How to test

Please refer (copy/paste) the test section from the User Story. This should include

The initial state: Have an initial test set with entities that have outboud and inbound relations.
What and how to test: Make call to the /entities/template_identifier, /entities/template_identifier/entity_identifier and /entities/search endpoints.
Expected results: When calling any of the enpoints that output entities information in a EntityDtout contract, the relations (inbound and outbound) should be now grouped in the relations section. The relations_as_target field shoud not exists.

Breaking changes (if any)

API JSON schema modification (existing resource / behavior)
N/A

Context of the Breaking Change

The EntityDtoOut contract has change.

Result of the Breaking Change

The relation_as_target fiel have been removed.
The relations (inbound and outbound) are now grouped in the relations section.
The relation summary have now the template identifer information

github-code-quality · 2026-07-08T12:21:31Z

Code Coverage Overview

Languages: Java

Java / code-coverage/jacoco

The overall coverage in the feat/update-entity-o... branch remains at 89%, unchanged from the main branch.

Show a code coverage summary of the most impacted files.

File	main `5059903`	feat/update-entity-o... `179d70b`	+/-
`com/decathlon/i...aphAdapter.java`	82%	73%	-9%
`com/decathlon/i...aphService.java`	92%	88%	-4%
`com/decathlon/i...oOutMapper.java`	87%	86%	-1%
`com/decathlon/i...maryDtoOut.java`	0%	0%	0%
`com/decathlon/i...raphHelper.java`	0%	95%	+95%
`com/decathlon/i...wDirection.java`	0%	100%	+100%
`com/decathlon/i...tityDtoOut.java`	0%	100%	+100%
`com/decathlon/i...SummaryDto.java`	0%	100%	+100%

_{Updated July 17, 2026 10:56 UTC
Code Coverage is in Public Preview. Learn more and provide us with your feedback.}

Copilot

Pull request overview

This PR updates the Entities API response contract to provide a unified relations structure that combines outbound and inbound relations, and enriches related entity summaries with template_identifier so clients can identify related entity types without additional lookups.

Changes:

Reworked entity output DTOs (EntityDtoOut, EntitySummaryDto) to support unified relations and include template_identifier in relation summaries.
Updated relation-summary persistence query and mapping to provide inbound relation source template identifiers.
Updated OpenAPI (swagger.yaml) and integration-test JSON fixtures to reflect the new response schema (including removal of relations_as_target from responses).

Reviewed changes

Copilot reviewed 14 out of 16 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/main/java/com/decathlon/idp_core/infrastructure/adapters/api/mapper/entity/EntityDtoOutMapper.java	Builds unified relations map and injects template identifiers into relation summaries
src/main/java/com/decathlon/idp_core/infrastructure/adapters/api/dto/out/entity/EntityDtoOut.java	Refactors entity response DTO to a unified `relations`-only shape
src/main/java/com/decathlon/idp_core/infrastructure/adapters/api/dto/out/entity/EntitySummaryDto.java	Adds `templateIdentifier` to related entity summaries and converts to record
src/main/java/com/decathlon/idp_core/infrastructure/adapters/persistence/repository/JpaRelationRepository.java	Extends native query projection to include source template identifier for inbound relation summaries
src/main/java/com/decathlon/idp_core/domain/model/entity/RelationAsTargetSummary.java	Extends domain summary model to carry `sourceTemplateIdentifier`
docs/src/static/swagger.yaml	Updates OpenAPI schemas to remove `relations_as_target` from responses and add `template_identifier` to entity summaries
src/test/resources/integration_test/json/entity/v1/searchEntities_200_startsWith.json	Updates expected entity search response fixture for unified relations + template identifiers
src/test/resources/integration_test/json/entity/v1/searchEntities_200_orTemplates.json	Updates expected entity search response fixture for unified relations + template identifiers
src/test/resources/integration_test/json/entity/v1/searchEntities_200_neq.json	Updates expected entity search response fixture for unified relations
src/test/resources/integration_test/json/entity/v1/searchEntities_200_byTemplateAndProperty.json	Updates expected entity search response fixture for unified relations + template identifiers
src/test/resources/integration_test/json/entity/v1/searchEntities_200_byRelationsAsTargetPresence.json	Updates expected entity search response fixture reflecting inbound relations now in `relations`
src/test/resources/integration_test/json/entity/v1/searchEntities_200_byRelationsAsTarget.json	Updates expected entity search response fixture reflecting inbound relations now in `relations`
src/test/resources/integration_test/json/entity/v1/searchEntities_200_byRelationNameEq.json	Updates expected entity search response fixture for unified relations + template identifiers
src/test/resources/integration_test/json/entity/v1/searchEntities_200_byRelationNameContains.json	Updates expected entity search response fixture for unified relations + template identifiers
src/test/resources/integration_test/json/entity/v1/getEntities_200_relationsAsTargetIdentifier.json	Updates expected get-entities response fixture reflecting inbound relations now in `relations`
src/test/resources/integration_test/json/entity/v1/getEntities_200_identifierEquals.json	Updates expected get-entities response fixture for unified relations + template identifiers

evebrnd

There are many mentions of relations_as_target in tests and the documentation that should be cleaned / updated.
PR title is missing a '!' to declare the breaking change

evebrnd · 2026-07-08T15:17:45Z

+  private Map<String, List<EntitySummaryDto>> buildUnifiedRelationsMap(Entity entity,
+      Map<String, EntitySummaryDto> relatedEntitiesSummaries,
      Map<String, List<RelationAsTargetSummary>> relationTargetOwnershipsMap) {
-    List<RelationAsTargetSummary> relationAsTargetSummaries = relationTargetOwnershipsMap


RelationAsTargetSummaryDtoOut class can be deleted as well

evebrnd · 2026-07-08T15:27:02Z

+/// - Template-aware relation summaries for unified API responses
 public record RelationAsTargetSummary(String targetEntityIdentifier, String relationName,
-    String sourceEntityIdentifier, String sourceEntityName) {
+    String sourceEntityIdentifier, String sourceEntityName, String sourceTemplateIdentifier) {


Considering sourceTemplateIdentifier is never used by the domain, isn't more an infra concern ? And should only be for dto and api responses

Actually at the end RelationAsTargetSummary object is the metadata for an entity. (identifier, name, template identifier) so it is stil a domain concern. I'l will check for maybe change the name. Or manage this in another way.

This is still used by the mapper for the search. I propose to treat the mapper update for the search in another pr.

Copilot

Pull request overview

Copilot reviewed 25 out of 28 changed files in this pull request and generated 10 comments.

Comments suppressed due to low confidence (1)

docs/src/concepts/entities.md:247

The response example under "Relations in Responses" is now missing template_identifier in relation summaries, which the PR introduces as part of the unified relations API. This makes the docs inconsistent with the updated contract.

In API responses, relations are grouped by name and include summary information about each target entity:

```json
{
  "relations": {

+    // Load entity graphs in batch
+    Map<UUID, Entity> entityGraphs = entityGraphRepositoryPort.findEntityGraph(entityUuids, 1, true,
+        EntityGraphTraversalMode.DIRECT_LINEAGE);

-  private static record GraphTraversalContext(Map<UUID, Entity> entityMap,
-      Map<EntityCompositeKey, UUID> textToUuidLookup,
-      Map<String, Map<String, List<UUID>>> inboundIndex, boolean includeProperties,
-      Set<String> propertyFilter, Set<String> relationFilter, Set<String> activeStack,
-      Map<String, EntityGraphNode> memoCache, // High-speed in-memory reuse cache
-      EntityGraphTraversalMode mode) {
-  }
+    // Call the helper to build graph nodes
+    Map<UUID, EntityGraphNode> graphsByUuid = entityGraphHelper.buildGraphNodesForEntityIds(
+        entityGraphs, true, Set.of(), Set.of(), EntityGraphTraversalMode.DIRECT_LINEAGE, 1);


Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Andrés Brand <andresbrand@gmail.com>

Unify graph retrieving methods

Unify graph retrieving methods Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Andrés Brand <andresbrand@gmail.com>

Unify graph retrieving methods

sonarqubecloud · 2026-07-17T10:56:23Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
88.4% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

brandPittCode changed the title ~~Feat(entity): update entity output for having relations grouped~~ feat(entity): update entity output for having relations grouped Jul 8, 2026

brandPittCode changed the title ~~feat(entity): update entity output for having relations grouped~~ feat(api): update entity output for having relations grouped Jul 8, 2026

brandPittCode requested a review from Copilot July 8, 2026 12:28

Copilot started reviewing on behalf of brandPittCode July 8, 2026 12:28 View session

Copilot AI reviewed Jul 8, 2026

View reviewed changes

Comment thread ...ava/com/decathlon/idp_core/infrastructure/adapters/api/mapper/entity/EntityDtoOutMapper.java

Comment thread ...ava/com/decathlon/idp_core/infrastructure/adapters/api/mapper/entity/EntityDtoOutMapper.java Outdated

evebrnd requested changes Jul 8, 2026

View reviewed changes

github-code-quality Bot found potential problems Jul 13, 2026

View reviewed changes

Comment thread src/main/java/com/decathlon/idp_core/domain/service/entity_graph/EntityGraphHelper.java Fixed

github-code-quality Bot found potential problems Jul 16, 2026

View reviewed changes

Comment thread src/main/java/com/decathlon/idp_core/domain/service/entity_graph/EntityGraphHelper.java Fixed

brandPittCode changed the title ~~feat(api): update entity output for having relations grouped~~ feat(api)!: update entity output for having relations grouped Jul 16, 2026

brandPittCode requested a review from Copilot July 16, 2026 12:44

Copilot started reviewing on behalf of brandPittCode July 16, 2026 12:45 View session

Copilot AI reviewed Jul 16, 2026

View reviewed changes

etiennej70 force-pushed the main branch from d29eba6 to 5059903 Compare July 17, 2026 09:00

brandPittCode and others added 16 commits July 17, 2026 12:25

feat(core): update Entity Dto contract, mapper and controllers tests

bde7650

feat(core): update Entity Dto contract, mapper and controllers tests

5de8436

feat(core): update Entity Dto contract, mapper and controllers tests

c7efad0

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Andrés Brand <andresbrand@gmail.com>

feat(core): update Entity Dto contract, mapper and controllers tests

6be5966

feat(core): update Entity Dto contract, mapper and controllers tests

a104d92

feat(core): update Entity Dto contract, mapper and controllers tests

de07bd3

feat(core): update Entity Dto contract, mapper and controllers tests

a14ee99

feat(core): update Entity Dto contract, mapper and controllers tests

61ee074

feat(core): update Entity Dto contract, mapper and controllers tests

3cfe929

feat(core): update Entity output contract.

2632230

Unify graph retrieving methods

feat(core): update Entity output contract.

646e269

Unify graph retrieving methods

feat(core): update Entity output contract.

d4dad57

Unify graph retrieving methods

feat(core): update Entity output contract

87ad843

Unify graph retrieving methods

feat(core): update Entity output contract

7bdbefc

Unify graph retrieving methods Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Andrés Brand <andresbrand@gmail.com>

feat(core): update Entity output contract

99a8a26

Unify graph retrieving methods Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Andrés Brand <andresbrand@gmail.com>

feat(core): update Entity output contract

9dde05e

Unify graph retrieving methods

feat(core): update Entity output contract

179d70b

Unify graph retrieving methods

brandPittCode force-pushed the feat/update-entity-output-for-having-relations-grouped branch from b57855e to 179d70b Compare July 17, 2026 10:52

Uh oh!

Conversation

brandPittCode commented Jul 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Description

What this PR Provides

Review

How to test

Breaking changes (if any)

Context of the Breaking Change

Result of the Breaking Change

Uh oh!

github-code-quality Bot commented Jul 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Coverage Overview

Java / code-coverage/jacoco

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!

evebrnd left a comment

Choose a reason for hiding this comment

Uh oh!

evebrnd Jul 8, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

evebrnd Jul 8, 2026

Choose a reason for hiding this comment

Uh oh!

brandPittCode Jul 8, 2026

Choose a reason for hiding this comment

Uh oh!

brandPittCode Jul 16, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud Bot commented Jul 17, 2026

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

brandPittCode commented Jul 8, 2026 •

edited

Loading

github-code-quality Bot commented Jul 8, 2026 •

edited

Loading