📋 Description
Component Reuse enables teams to easily build, manage, and repurpose modular content elements across documentation.
💎 Business Value
Accelerates authoring and ensures accuracy and brand alignment at scale.
✓ Merged to main
🕐 Development time: 4d-05h-58m⏱ Time to deployment: 0d-00h-02m
📋 Development Summary
Summary: Component reuse functionality was implemented and merged to main, centered on a metadata-declared architecture for tracking and managing component references. The work introduced API endpoints and supporting services for reference registration and unregistration, added audit logging for traceability, and updated documentation and implementation plans to reflect the finalized approach and deferred build-time resolution tasks.
Key Changes:
- Implemented component reference management endpoints and backend services to support component reuse workflows.
- Refactored the component reuse architecture to a metadata-declared approach for reference tracking and integration.
- Added audit logging for component reference registration and unregistration to improve traceability and governance.
- Updated specifications, research notes, implementation plans, and recent-changes documentation for component reuse and related verification work.
- Removed unused XPath position types and related validations from `InsertPosition`, and corrected test parameter naming in `HierarchyServiceTests`.
Impact: These changes establish the technical foundation for reusable components with clearer reference management, better observability, and improved maintainability. This enables safer reuse across the platform while reducing ambiguity in implementation and supporting future integration work.
🔧 API Changes (10 files)
-
A
src/Aleido.Platform.API/Endpoints/ObjectReferenceEndpoints.cs
-
M
src/Aleido.Platform.API/Extensions/ServiceRegistrationExtensions.cs
-
M
src/Aleido.Platform.API/Extensions/WebApplicationExtensions.cs
-
A
src/Aleido.Platform.API/Models/Requests/ComponentRequests.cs
-
A
src/Aleido.Platform.API/Models/Responses/ComponentResponses.cs
-
M
src/Aleido.Platform.API/README.md
-
A
src/Aleido.Platform.API/Services/ComponentService.cs
-
M
src/Aleido.Platform.API/Services/Hierarchy/HierarchyService.Checkout.cs
-
M
src/Aleido.Platform.API/Services/Hierarchy/HierarchyService.cs
-
A
src/Aleido.Platform.API/Services/IComponentService.cs
📝 Commit Log
8581bdfbb docs: Update recent changes section to reflect component reference tracking and related features
de5d60255 Merge branch '031-component-reuse' of https://dev.azure.com/aleidotech/AleidoTechCore/_git/AleidoTechCore into 031-component-reuse
c9c2ac2c6 fix: Correct parameter naming for event emitter in HierarchyServiceTests
07021caa0 feat: Implement audit logging for component reference registration and unregistration
3be155a5f refactor: defer build-time resolution tasks for User Story 10 to future sprint
70b719f88 feat: Add component reference management endpoints and services
fe12d1520 refactor: update implementation plan and tasks for component reuse verification and integration with spec 023
65ffe2931 Remove component reference management functionality
9c3b2e65c Refactor component reuse architecture to metadata-declared approach
a65a1b6da feat: Add component reference management endpoints and services
d55f8917c refactor: remove unused XPath position type and related validations from InsertPosition
7204da699 Add research and task documentation for component reuse implementation
26ad31afe feat: Add component reference management endpoints and services
ac4bb5484 refactor: remove unused XPath position type and related validations from InsertPosition
ae7a888a0 Add research and task documentation for component reuse implementation
44c4b7a64 add spec 031-component-reuse
63a6610e1 feat: Implement audit logging for component reference registration and unregistration
a8c075038 refactor: defer build-time resolution tasks for User Story 10 to future sprint
281aa4af2 feat: Add component reference management endpoints and services
ff4dd3a1a refactor: update implementation plan and tasks for component reuse verification and integration with spec 023
bd821d3da Remove component reference management functionality
c48a52917 Refactor component reuse architecture to metadata-declared approach
beb739522 Merge branch '031-component-reuse' of https://dev.azure.com/aleidotech/AleidoTechCore/_git/AleidoTechCore into 031-component-reuse
64495ab8b feat: Add component reference management endpoints and services
026254115 refactor: remove unused XPath position type and related validations from InsertPosition
560338ebe Add research and task documentation for component reuse implementation
38a842d5a add spec 031-component-reuse
21f4c1f7a feat: Add component reference management endpoints and services
7f4c8af59 refactor: remove unused XPath position type and related validations from InsertPosition
1e0cb5b5f Add research and task documentation for component reuse implementation
340a82234 Merge branch '031-component-reuse' of https://dev.azure.com/aleidotech/AleidoTechCore/_git/AleidoTechCore into 031-component-reuse
290f23de3 add spec 031-component-reuse