Skip to content

USubscription v4 API re-write#326

Open
AnotherDaniel wants to merge 11 commits into
eclipse-uprotocol:mainfrom
etas-contrib:usubscription_v4
Open

USubscription v4 API re-write#326
AnotherDaniel wants to merge 11 commits into
eclipse-uprotocol:mainfrom
etas-contrib:usubscription_v4

Conversation

@AnotherDaniel

@AnotherDaniel AnotherDaniel commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Re-write of the uSubscription service specification, with associated API definitions using asyncapi, referencing protobuf message definitions.

This breaks the existing protobuf api - simplification, type changes, name changes, parameter ordering, etc.

Re-write initiated by some vague areas in the previous spec, as well as #320 and #321

Note: I still have to wrangle with oft, to verify requirement markers. WIP...

@AnotherDaniel AnotherDaniel self-assigned this Jun 16, 2026
@AnotherDaniel AnotherDaniel added enhancement New feature or request breaking change This pull request introduces a change to public API which is not backwards compatible labels Jun 16, 2026

@sophokles73 sophokles73 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are a few things that I do not understand. In particular around the subscription change notifications. FMPOV we will need to be super clear about what these are good/used for before we make them mandatory ...

Comment thread up-core-api/uprotocol/core/README.adoc Outdated
Comment thread up-core-api/uprotocol/core/usubscription/v4/usubscription.proto Outdated
Comment thread up-core-api/uprotocol/core/usubscription/v4/usubscription.proto Outdated
Comment thread up-core-api/uprotocol/core/usubscription/v4/usubscription.proto Outdated
Comment thread up-core-api/uprotocol/core/usubscription/v4/usubscription.proto Outdated
Comment thread up-l3/usubscription/v4/README.adoc Outdated
Comment thread up-l3/usubscription/v4/README.adoc Outdated
Comment thread up-l3/usubscription/v4/README.adoc Outdated
Comment thread up-l3/usubscription/v4/README.adoc Outdated
Comment thread up-l3/usubscription/v4/README.adoc Outdated
When a client calls the `Subscribe()` function for a remote topic with xref:subscription-status[SubscriptionStatus] `UNSUBSCRIBE_PENDING`, uSubscription service *MUST* initiate the regular remote subscription process, i.e. send a subscription request to the remote uSubscription service and set xref:subscription-status[SubscriptionStatus] to `SUBSCRIBE_PENDING`.

[.specitem,oft-sid="req~usubscription-subscribe-notifications~1",oft-needs="impl,utest",oft-tags="USubscription"]
After a client calls the `Subscribe()` function, uSubscription service *MUST* send subscription change Notifications to that client whenever there are any changes to the state of the subscribed topic.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What events will cause such a notification being sent to the client? What information will be conveyed to the client?
Is this about getting notified when the publisher does no longer publish to the topic?

AnotherDaniel and others added 2 commits June 17, 2026 17:10
Co-authored-by: Kai Hudalla <sophokles.kh@gmail.com>
Comment thread up-core-api/uprotocol/core/usubscription/v4/usubscription.proto Outdated
Comment thread up-core-api/uprotocol/core/usubscription/v4/usubscription.proto Outdated
Comment thread up-l3/usubscription/v4/README.adoc Outdated
Comment thread up-l3/usubscription/v4/README.adoc
Comment thread up-l3/usubscription/v4/README.adoc Outdated
Comment thread up-l3/usubscription/v4/README.adoc Outdated
Comment thread up-l3/usubscription/v4/README.adoc Outdated
Comment thread up-l3/usubscription/v4/README.adoc Outdated
Comment thread up-l3/usubscription/v4/README.adoc Outdated
Comment thread up-l3/usubscription/v4/README.adoc Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking change This pull request introduces a change to public API which is not backwards compatible enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants