Enhancements Subscription/Notification Architecture for Fall25 by PedroDiez · Pull Request #464 · camaraproject/Commonalities

PedroDiez · 2025-05-16T16:58:55Z

What type of PR is this?

enhancement/feature

What this PR does / why we need it:

This PR provides a resolution for topics commented within Issue #437.
Some points has been discussed within #440.

Explanation about PR:

Decided to not impact CAMARA-API-Design-Guide.md and CAMARA_common.yaml documentation.
- Rationale is that the sink concept is managed within CAMARA-API-Event-Subscription-and-Notification-Guide.md and
  event-subscription-template.yaml
- Also in CAMARA-API-Design-Guide.md it is defined the format: 400 | {{SPECIFIC_CODE}} | {{SPECIFIC_CODE_MESSAGE}}, so
  implicitly cover the error 400 - INVALID_SINK as well as other errors already documented in the event-subscription- template.yaml (e.g. 400 - INVALID_TOKEN)
NOTE: So, as the relevant documents are CAMARA-API-Event-Subscription-and-Notification-Guide.md and
event-subscription-template.yaml think is better to not duplicate info as implies more maintenance actions and does not
provide any additional value. Anyway up to the WG, just to be transparent with the approach.
Impacted CAMARA-API-Event-Subscription-and-Notification-Guide.md. Added new sections:
- 3.2. subscription-begins event
- 3.3 subscription-updates event
Impacted event-subscription-template.yaml
- Added sink pattern and specific 400 - INVALID_SINK error
- In POST /subscriptions, settle subscriptionId as mandatory in response. As per current model definition it also makes it
  mandatory in DELETE /subscriptions. That also makes sense, to deal with Asynchronous DELETE scenarios and also when the
  status DELETED is managed by a Telco Operator.
- Define and add support for subscription-begins event
- Define and add support for subscription-updates event
- Fix typo removing unused exception since Spring25 - 403 - INVALID_TOKEN_CONTEXT
- (NEW - 04/JUN) Alignment with PR#455 and remove 422 - IDENTIFIER_MISMATCH exception. Commit 738731f22328ecaf6eaa4042e4d0e01fcfc9ed47

Which issue(s) this PR fixes:

Fixes #437

Does this PR introduce a breaking change?

Yes
No

subscription-ends event is renamed to subscription-ended event.
This is a breaking change in terms of design due to an event type is renamed.
APIs impacted (i.e. subscription APIs) are in initial versions so as the change can be accommodated without impacting major version.

422 - IDENTIFIER_MISMTACH exception is removed

Special notes for reviewers:

N/A

Changelog input

 Enhancements Subscription/Notification Architecture for Fall25

Additional documentation

N/A

artifacts/camara-cloudevents/event-subscription-template.yaml

rartych · 2025-05-20T10:36:48Z

For me subscription-update sounds more natural (singular noun) as the event contains one change only.
@eric-murray @Kevsy ?

bigludo7

One small miscue to fix.

documentation/CAMARA-API-Event-Subscription-and-Notification-Guide.md

Co-authored-by: Rafal Artych <121048129+rartych@users.noreply.github.com>

bigludo7

LGTM

rartych · 2025-05-26T14:42:13Z

I am not sure if there is clear requirement if API definitions should add subscription-begins and subscription-updates - is it optional or mandatory?

other consideration - changing names:
subscription-begins --> subscription-started
subscription-updates --> subscription-updated
subscription-ends --> subscription-ended

Any view on that?

pjhac · 2025-05-26T15:59:08Z

I am not sure if there is clear requirement if API definitions should add subscription-begins and subscription-updates - is it optional or mandatory?

other consideration - changing names: subscription-begins --> subscription-started subscription-updates --> subscription-updated subscription-ends --> subscription-ended

Any view on that?

Personally I would also prefer to use the past, as the action already took place.

bigludo7 · 2025-05-26T16:04:52Z

Hello
@rartych considering your questions:

I'm fine to have it in all CAMARA Subscription API definition but do we consider them as mandatory for an implementation? I mean if an implem did not trigger subscription-begins do we consider it as non CAMARA compliant? Just my perspective but we should not enforce this - only recommend use of them. Happy to hear from the team.

For the name I'm fine with both so will follow team preference :)

sachinvodafone · 2025-05-27T11:03:49Z

Hello @rartych considering your questions:

I'm fine to have it in all CAMARA Subscription API definition but do we consider them as mandatory for an implementation? I mean if an implem did not trigger subscription-begins do we consider it as non CAMARA compliant? Just my perspective but we should not enforce this - only recommend use of them. Happy to hear from the team.

For the name I'm fine with both so will follow team preference :)

I believe, starting with optional events provides flexibility for providers to adopt them based on their current capabilities but it may result in inconsistent behaviors—such as one provider supporting an event while another does not. This could require clients to adapt to different implementations during integration.

As part of an initial phased approach, keeping events optional makes sense. However, after collecting feedback and assessing the readiness of telecom providers to support these scenarios consistently, we can move towards making these events mandatory for long term.

PedroDiez · 2025-05-28T10:19:25Z

Hi, @rartych, @pjhac, @bigludo7, @sachinvodafone.

Fine to document the new events are optional. I will make clarification for the subscription-begins that is recommended when the subscription request flow is asynchronous
Fine to rename to past-tense

subscription-begins --> subscription-started
subscription-updates --> subscription-updated
subscription-ends --> subscription-ended

Will be updating documentation with these points

bigludo7

LGTM

patrice-conil

LGTM

…o enhancements_subscription_notification_architecture_fall25

PedroDiez · 2025-06-04T18:02:04Z

04/JUN: Taking advantage of this PR, have also covered aligment with PR#455 and remove 422 - IDENTIFIER_MISMATCH exception. Commit 738731f22328ecaf6eaa4042e4d0e01fcfc9ed47

cc @rartych, @bigludo7, @patrice-conil, @eric-murray

patrice-conil

LGTM

bigludo7

LGTM

documentation/CAMARA-API-Event-Subscription-and-Notification-Guide.md

…uide.md Co-authored-by: Rafal Artych <121048129+rartych@users.noreply.github.com>

PedroDiez

A few more alignments

documentation/CAMARA-API-Event-Subscription-and-Notification-Guide.md

…uide.md

jlurien

LGTM

patrice-conil

LGTM

Enhancements Subscription/Notification Architecture for Fall25

5d95f67

PedroDiez requested review from jlurien, patrice-conil, rartych and shilpa-padgaonkar as code owners May 16, 2025 16:58

PedroDiez requested review from eric-murray and sachinvodafone May 16, 2025 16:59

rartych reviewed May 20, 2025

View reviewed changes

artifacts/camara-cloudevents/event-subscription-template.yaml Outdated Show resolved Hide resolved

rartych requested a review from bigludo7 May 20, 2025 10:37

rartych added enhancement New feature or request Fall25 labels May 20, 2025

bigludo7 reviewed May 20, 2025

View reviewed changes

documentation/CAMARA-API-Event-Subscription-and-Notification-Guide.md Outdated Show resolved Hide resolved

rartych mentioned this pull request May 20, 2025

Preparation of Meta-relase Fall25 scope #423

Closed

PedroDiez and others added 2 commits May 22, 2025 16:42

Update artifacts/camara-cloudevents/event-subscription-template.yaml

1913e7a

Co-authored-by: Rafal Artych <121048129+rartych@users.noreply.github.com>

fix_some_wording_alignment_and_typos

c1a34ec

PedroDiez requested review from bigludo7 and rartych May 22, 2025 15:12

bigludo7 approved these changes May 22, 2025

View reviewed changes

updates_after_1st_transversal_review

bcdbbff

PedroDiez requested a review from bigludo7 May 28, 2025 11:28

bigludo7 approved these changes May 28, 2025

View reviewed changes

rartych mentioned this pull request May 28, 2025

Add event-notification feature file template #470

Merged

2 tasks

patrice-conil previously approved these changes Jun 4, 2025

View reviewed changes

Merge branch 'main' of https://github.com/PedroDiez/Commonalities int…

5a826ba

…o enhancements_subscription_notification_architecture_fall25

remove_identifier_mismatch_exception

738731f

PedroDiez dismissed patrice-conil’s stale review via 738731f June 4, 2025 17:57

PedroDiez requested review from bigludo7 and patrice-conil June 4, 2025 17:59

patrice-conil previously approved these changes Jun 5, 2025

View reviewed changes

bigludo7 approved these changes Jun 5, 2025

View reviewed changes

rartych reviewed Jun 5, 2025

View reviewed changes

documentation/CAMARA-API-Event-Subscription-and-Notification-Guide.md Outdated Show resolved Hide resolved

rartych reviewed Jun 5, 2025

View reviewed changes

documentation/CAMARA-API-Event-Subscription-and-Notification-Guide.md Outdated Show resolved Hide resolved

Update documentation/CAMARA-API-Event-Subscription-and-Notification-G…

3a2629d

…uide.md Co-authored-by: Rafal Artych <121048129+rartych@users.noreply.github.com>

PedroDiez dismissed patrice-conil’s stale review via 3a2629d June 5, 2025 13:48

Update documentation/CAMARA-API-Event-Subscription-and-Notification-G…

40301d9

…uide.md Co-authored-by: Rafal Artych <121048129+rartych@users.noreply.github.com>

PedroDiez requested review from patrice-conil and rartych June 5, 2025 13:48

PedroDiez commented Jun 5, 2025

View reviewed changes

documentation/CAMARA-API-Event-Subscription-and-Notification-Guide.md Outdated Show resolved Hide resolved

documentation/CAMARA-API-Event-Subscription-and-Notification-Guide.md Outdated Show resolved Hide resolved

PedroDiez added 2 commits June 5, 2025 15:51

Update documentation/CAMARA-API-Event-Subscription-and-Notification-G…

44d99ab

…uide.md

Update documentation/CAMARA-API-Event-Subscription-and-Notification-G…

ac5bff8

…uide.md

PedroDiez requested a review from bigludo7 June 6, 2025 08:50

rartych approved these changes Jun 6, 2025

View reviewed changes

jlurien approved these changes Jun 10, 2025

View reviewed changes

patrice-conil approved these changes Jun 10, 2025

View reviewed changes

rartych merged commit 1475bd0 into camaraproject:main Jun 10, 2025
1 check passed

rartych mentioned this pull request Jun 13, 2025

Update of issue_review_template_fall25_m3.md for subscription APIs camaraproject/ReleaseManagement#222

Merged

rartych mentioned this pull request Jul 9, 2025

Prepare r3.1 camaraproject/SimSwap#226

Merged

Conversation

PedroDiez commented May 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What type of PR is this?

What this PR does / why we need it:

3.2. subscription-begins event

3.3 subscription-updates event

Which issue(s) this PR fixes:

Does this PR introduce a breaking change?

Special notes for reviewers:

Changelog input

Additional documentation

Uh oh!

Uh oh!

rartych commented May 20, 2025

Uh oh!

bigludo7 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bigludo7 left a comment

Choose a reason for hiding this comment

Uh oh!

rartych commented May 26, 2025

Uh oh!

pjhac commented May 26, 2025

Uh oh!

bigludo7 commented May 26, 2025

Uh oh!

sachinvodafone commented May 27, 2025

Uh oh!

PedroDiez commented May 28, 2025

Uh oh!

bigludo7 left a comment

Choose a reason for hiding this comment

Uh oh!

patrice-conil left a comment

Choose a reason for hiding this comment

Uh oh!

PedroDiez commented Jun 4, 2025

Uh oh!

patrice-conil left a comment

Choose a reason for hiding this comment

Uh oh!

bigludo7 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

PedroDiez left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jlurien left a comment

Choose a reason for hiding this comment

Uh oh!

patrice-conil left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

PedroDiez commented May 16, 2025 •

edited

Loading

3.2. `subscription-begins` event

3.3 `subscription-updates` event