support for subscription notifications API specifications#17
Open
maheshc01 wants to merge 3 commits intocamaraproject:mainfrom
Open
support for subscription notifications API specifications#17maheshc01 wants to merge 3 commits intocamaraproject:mainfrom
maheshc01 wants to merge 3 commits intocamaraproject:mainfrom
Conversation
sachinvodafone
previously approved these changes
Dec 9, 2025
sachinvodafone
dismissed
their stale review
Need to finalise the API naming first
Contributor
Author
|
the name of the API repo is not finalized and this is being planned for a release based on the latest release management process. |
hdamker
reviewed
Mar 8, 2026
Co-authored-by: Herbert Damker <[email protected]>
maxl2287
reviewed
Mar 8, 2026
Comment on lines
+13
to
+17
| # Relevant terms and definitions | ||
|
|
||
| * **Device**: A device refers to any physical entity that can connect to a network and participate in network communication. | ||
|
|
||
| At least one identifier for the device out of four options must be provided: IPv4 address, IPv6 address, Phone number, or Network Access Identifier assigned by the mobile network operator for the device. Where more than one device identifier is provided, only one identifier will be selected by the implementation and this choice indicated to the API consumer in the session creation response. |
Comment on lines
+699
to
+710
| Device: | ||
| description: | | ||
| End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators. | ||
|
|
||
| The developer can choose to provide the below specified device identifiers: | ||
|
|
||
| * `ipv4Address` | ||
| * `ipv6Address` | ||
| * `phoneNumber` | ||
| * `networkAccessIdentifier` | ||
|
|
||
| NOTE: the MNO might support only a subset of these options. The API invoker can provide multiple identifiers to be compatible across different MNOs. In this case the identifiers MUST belong to the same device. |
There was a problem hiding this comment.
Suggested change
| Device: | |
| description: | | |
| End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators. | |
| The developer can choose to provide the below specified device identifiers: | |
| * `ipv4Address` | |
| * `ipv6Address` | |
| * `phoneNumber` | |
| * `networkAccessIdentifier` | |
| NOTE: the MNO might support only a subset of these options. The API invoker can provide multiple identifiers to be compatible across different MNOs. In this case the identifiers MUST belong to the same device. | |
| Device: | |
| description: | | |
| End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators. | |
| The developer can choose to provide the below specified device identifiers: | |
| * `ipv4Address` | |
| * `ipv6Address` | |
| * `phoneNumber` | |
| * `networkAccessIdentifier` | |
| NOTE1: the network operator might support only a subset of these options. The API invoker can provide multiple identifiers to be compatible across different network operators. In this case the identifiers MUST belong to the same device. | |
| NOTE2: as for this Commonalities release, we are enforcing that the networkAccessIdentifier is only part of the schema for future-proofing, and CAMARA does not currently allow its use. After the CAMARA meta-release work is concluded and the relevant issues are resolved, its use will need to be explicitly documented in the guidelines. | |
Referencing to the Commonalities r3.4 common Device, I would add these notes here.
https://github.com/camaraproject/Commonalities/blob/r3.4/artifacts/CAMARA_common.yaml#L61C81-L72C1
wdyt?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
introduces the support for creating subscriptions and receive notifications when there is any change in the media streaming rate.
Which issue(s) this PR fixes:
Fixes #14
Special notes for reviewers:
Changelog input
Additional documentation
This section can be blank.