Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Commonalities 0.5 aligment #65

Merged

Conversation

stroncoso-quobis
Copy link
Collaborator

@stroncoso-quobis stroncoso-quobis commented Jan 24, 2025

What type of PR is this?

Add one of the following kinds:

  • correction
  • enhancement/feature

What this PR does / why we need it:

  • Align with Commonalities 0.5 for CAMARA APIs

Which issue(s) this PR fixes:

Fixes #63

Special notes for reviewers:

Work in progress

Changelog input

 release-note
- Aligment with Commonalities 0.5 for the three APIs
- Added `openId` as securitySchema.
  - `webrtc-events` already using it. No changes there
  - `webrtc-registration` and `webrtc-call-handling`:
    - remove BearerAuth and leave openId as security schema
    - APIs scope naming review: commit 54d1048
- Review response codes
  - `webrtc-registration`: added x-correlator and API reponses review: commit 66ce28
  - `webrtc-call-handling`: added x-correlator and API reponses review: commit 93e54d8

Additional documentation

docs

- Aligned ErrorInfo schema
- Added error schema: CreateSessionBadRequest400
- Added error schema: CreateSessionForbidden403
- Reviewed and added Generic404
- Added x-correlator on header responses
- Reordered components to fit comms repo
- Reviewed all generic errors
- Replaced SessionNotFOund404 by Generic404
- Reviewed all generic errors
- Reordered components
- Added x-correlator to responses
- ErrorInfo schema aligned
@stroncoso-quobis stroncoso-quobis marked this pull request as ready for review February 4, 2025 16:45
@teikuran
Copy link
Contributor

Regarding webrtc-registration, channelId cannot be used because it is assigned through webrtc notification-channel, which is not included in the Spring 25 release.
Therefore, channelId data schema should be removed. I believe this removal will have no impact, as the Spring 25 release relies on the webhook callback method, which does not use the concept of channelId.

channelId:
 type: string  
 description: ID of an existing notification channel.  
 example: "channel_id_123"

@deepakjaiswal1
Copy link
Collaborator

I agree; we should remove channelId since the notification channel has been descoped from the current release.

@deepakjaiswal1
Copy link
Collaborator

@stroncoso-quobis @teikuran
The deviceId is a unique identifier for the physical device where a WebRTC session is initiated. It is provided by the WebRTC application, it remains consistent across multiple installations or logins on the same device. Its primary function is to ensure that only one WebRTC session is active per device at a time, enabling the gateway to clean up any stale sessions if a new session is initiated on the same device.

The clientId, on the other hand, is assigned by the WebRTC gateway for each client instance or session. It is best practice for the gateway to issue a new clientId for each login or session. This approach helps the gateway maintain clear indexing or mapping for quicker processing and simplifies troubleshooting by clearly distinguishing one session from another.

@stroncoso-quobis stroncoso-quobis merged commit 452be2b into camaraproject:main Feb 13, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Action points to align with Commonalities 0.5
5 participants