Component Configuration Endpoint (common-module v6.6.0)
Status: In Progress — Phases 1+2 complete (10/24 tasks done)
Repositories: common-module, operations, api-test
Version targets: common-module v6.5.0 to v6.6.0, operations v2.15.1 to v2.16.0
Add a ModuleRegistry, ComponentBuilder, and ConfigurationEndpoint to common-module. This provides an OAM (Operations, Administration, Maintenance) HTTP endpoint that reports which modules are registered in a component and their current configuration.
Progress
Section titled “Progress”Phase 1 — common-module Core Types (complete)
Section titled “Phase 1 — common-module Core Types (complete)”ModuleRegistryandModuleEntrytypes.ConfigurationPayload,ModuleInfo,ModuleTypeDTOs.toConfigurationPayload()conversion function.- Unit tests.
Phase 2 — common-module Builder and Endpoint (complete)
Section titled “Phase 2 — common-module Builder and Endpoint (complete)”ComponentBuilderclass.Component.build()factory.configureServer(app, registry)overload with deprecation of the old signature.ConfigurationEndpointroute installer.- Integration tests.
Remaining Work
Section titled “Remaining Work”Phase 5a — tests and review (next):
- T-14, T-15: Bruno API tests for the configuration endpoint (can start immediately).
- T-19: CHANGELOG update for
common-module(can start immediately). - T-16: Code review of
common-module(can start immediately).
Phase 3 — operations migration (blocked by T-20 merge):
- T-10 through T-13: Update
operationsto use the newComponentBuilderDSL.
Remaining Phase 5 — CHANGELOGs, reviews, PRs:
- T-17, T-18: Code reviews.
- T-21, T-23: CHANGELOG updates for
operationsandapi-test. - T-22, T-24: PR merges.
Worktrees
Section titled “Worktrees”All worktrees are clean as of the last session:
| Worktree | Branch | Status |
|---|---|---|
inventory-worktrees/registry | jmpicnic/inventory/registry | Phase 1 complete |
inventory-worktrees/builder | jmpicnic/inventory/builder | Phase 2 complete |
inventory-worktrees/operations | jmpicnic/inventory/operations | Waiting for T-10+ |
inventory-worktrees/apitest | jmpicnic/inventory/apitest | Waiting for T-14+ |
What the Endpoint Provides
Section titled “What the Endpoint Provides”Once deployed, GET /{component}/oam/configuration returns:
{ "component": "operations", "version": "2.16.0", "modules": [ { "name": "item", "type": "REFERENCE_DATA", ... }, { "name": "business-affiliate", "type": "REFERENCE_DATA", ... } ]}The endpoint requires no authentication and is used by monitoring tools and deployment verification scripts to confirm the component is healthy and running the expected module set.
Copyright: © Arda Systems 2025-2026, All rights reserved