Repository navigation
Endpoint names are not compliant with Commonalities r4.3 #235
Description
Activity
- added a parent issue
on Aug 6, 2026 This is a compliance gap against §6.5.
Proposal: trimming the redundantcall-noun since it's already implied by the API name (like in SimSwap API:POST /retrieve-date, notretrieve-sim-swap-date):POST /unconditional-call-forwardings→POST /retrieve-unconditional-forwardingPOST /call-forwardings→POST /retrieve-forwardings
operationIds should follow the same verb and be more explicit for MCP compatibility (verb + compound noun) :retrieveUnconditionalCallForwarding/retrieveCallForwardings.Scopes: per §6.6.1, a single-operation POST-verb path takes the scope
api-name:[resource:]action. So:call-forwarding-signal:unconditional-call-forwardings:read→call-forwarding-signal:unconditional-forwarding:retrievecall-forwarding-signal:call-forwardings:read→call-forwarding-signal:forwardings:retrieve
Other artifacts to update in the same PR, to avoid drift between spec and test suite:
.featurefiles — update allGiven/Whensteps referencing the old paths, operation names, and scopes,- documentation in 'info' object.
Happy to put together the PR if there's agreement on the naming direction.
Hello,
I support @rartych proposal in order to be compliant with CAMARA-API-Design-Guide for the name as stated by @eric-murray but also for scope name & the other stuff.As @FabrizioMoggio was very active for this API hoping also to have his green light.
The alternative solution to indicate that for unconditional CF the response is boolean is to use different action verb instead of
retrievefor examplecheck:
POST /unconditional-call-forwardings→POST /check-unconditional-forwarding
and so on.
Problem description
The two endpoints use POST because they are transferring sensitive data, not because they are creating any resource.
The Commonalities Design Guide states:
The current paths
POST /unconditional-call-forwardingsandPOST /call-forwardingsdo not include the verbretrieveto indicate that the are retrieving information only and not creating any resourceExpected behaviour
The endpoint paths need to be renamed by prefixing them with
retrieve-. In addition, asPOST /unconditional-call-forwardingsis retrieving a boolean status value, consider appending-status.e.g.:
POST /retrieve-unconditional-call-forwardings-statusPOST /retrieve-call-forwardingsAlternative solution
None
Additional context
None