Skip to content

Flow review - BYON#27

Merged
TEF-RicardoSerr merged 32 commits intocamaraproject:Developmentfrom
stroncoso-quobis:QUO-SantiagoTroncoso-flow
Jun 18, 2024
Merged

Flow review - BYON#27
TEF-RicardoSerr merged 32 commits intocamaraproject:Developmentfrom
stroncoso-quobis:QUO-SantiagoTroncoso-flow

Conversation

@stroncoso-quobis
Copy link
Collaborator

@stroncoso-quobis stroncoso-quobis commented Feb 16, 2024

What type of PR is this?

  • documentation

What this PR does / why we need it:

  • It covers the detailed BYON flow, separated on two main use cases: registration and call handling.
  • It provides a necessary asset to attract developers and to fully understand the API mechanisms.

Which issue(s) this PR fixes:

Fixes #18 #32

Special notes for reviewers:

Changelog input

taks(doc): Splitted diagrams and participant description included

Additional documentation

Included exported UML diagrams for easier review

-- Registration / De-registration--
BYON Registration 0 1 2

-- Notification channel --
BYON NotificationChannel 0 1 2

-- Call handling (Originating / Terminating) --
BYON Callhandling 0 1 2

@stroncoso-quobis
Copy link
Collaborator Author

Starting with changes on the Notification process following shared MoMs

@stroncoso-quobis
Copy link
Collaborator Author

Updated documentation, registration / notification diagram considered done.

@stroncoso-quobis
Copy link
Collaborator Author

Updated after today's meeting. Really appreciate feedback on salmon notes of the diagram.

@stroncoso-quobis
Copy link
Collaborator Author

Also considering splitting Registration(RACM) / Notification / CallHandling use cases. They are separate stages, working in parallel or dependant, but, to work with smaller images/documents will benefit all.

@stroncoso-quobis
Copy link
Collaborator Author

stroncoso-quobis commented Apr 8, 2024

Blocked due lack of status definition:

And blocked due JSON ACK definition. If we are talking about confirm status changes or to modify the SDP, an PUT/PATCH sould be the way. It must be valid for all notification channel mechanisms (websocket, PSN or webhook)
To discuss related with:

@stroncoso-quobis stroncoso-quobis force-pushed the QUO-SantiagoTroncoso-flow branch from cf4c14c to 6eaa474 Compare May 21, 2024 12:11
JavierVillaLabarra and others added 3 commits May 21, 2024 14:12
flow description of the API BYON.
- The contact information to include domain.com.
- In the CallHandling API, the status attribute description is updated.
@stroncoso-quobis stroncoso-quobis force-pushed the QUO-SantiagoTroncoso-flow branch 2 times, most recently from 62835ba to 286f6a3 Compare May 21, 2024 12:22
@stroncoso-quobis stroncoso-quobis marked this pull request as ready for review May 21, 2024 12:25
@stroncoso-quobis
Copy link
Collaborator Author

  • Updated to latest API version (headers and parameters)
  • Improved terminating flow
  • Uniform path on requests
  • Included base documentation for status

- Doc with status enumeration
- Uniform API requests and headers
- Fixed terminaing flow
- Replaced "params" by "headers"
@stroncoso-quobis stroncoso-quobis force-pushed the QUO-SantiagoTroncoso-flow branch from 286f6a3 to 13c9e73 Compare May 21, 2024 17:08
- Confirmed changes after meeting 21/05/24
- Specified vvoipSessionId and racmSessionId
- Updated notifications format and responses
@stroncoso-quobis
Copy link
Collaborator Author

stroncoso-quobis commented May 21, 2024

Ready for merge after review commented today on the meeting.

Following #29 session ID variable names.
Also fixed compilation of the PlanUML image of call handling, a little big too long.

cc.: @deepakjaiswal1 @TEF-RicardoSerr

Regards,

@deepakjaiswal1
Copy link
Collaborator

@stroncoso-quobis @TEF-RicardoSerr
Please find my comments below:
-- Registration / De-registration--
Flow #4: We need to highlight that channelId is provided only when the channel is externally created, meaning not by the WebRTC Gateway. If the notification channel is an independent service (i.e., not part of the WebRTC Gateway), it should be set up before the RACM session.
-- Notification channel --
Flow # 6: There is no URL for PNS channel. There could be other params along with registrationToken.
-- Call handling (Originating / Terminating) --
Can we capture SIP UPDATE flow also?

@deepakjaiswal1
Copy link
Collaborator

@stroncoso-quobis Can we also capture call-flow call hold & resume?
@pradeepachar-mavenir @TEF-RicardoSerr For the PUT request to /vvoip/{apiVersion}/sessions/{vvoipSessionId}/status, there are two scenarios: (a) the session is updated with no response body, and (b) the session is updated with a response body. I suggest using status code 204 for updates with no response body, and status code 200 for updates that include a response body.

@stroncoso-quobis
Copy link
Collaborator Author

stroncoso-quobis commented Jun 15, 2024

Hi @deepakjaiswal1 , reviewed flows after your revision

  • Included more detailed and accourate (v0.1.2) info about notification channels
  • Included more detail about UPDATE / PRACK on pre-ringing stages for IMS

Check updated UML renders on the PR description.

About the 204/200 in response to PUT actions, I suggest to keep the flow as it is to explain the base concept and get more in detail, maybe on the Markdown plain document or in the openApi description. Under that point of view, I consider that a "generic 204" is ok for this flow overview.

Regarding the call-flow call hold & resume I agree that it is a great resource to add. I can do it, but I suggest creating a new call flow file on a separate PR and try to touch base with this one.

Thanks for your comments! 🙇

@TEF-RicardoSerr TEF-RicardoSerr merged commit 80384d2 into camaraproject:Development Jun 18, 2024
@stroncoso-quobis stroncoso-quobis deleted the QUO-SantiagoTroncoso-flow branch July 16, 2024 16:33
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.

5 participants