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

task(doc): Flow diagrams reviewed #42

Merged

Conversation

stroncoso-quobis
Copy link
Collaborator

What type of PR is this?

  • documentation

What this PR does / why we need it:

  • It covers the detailed BYON flow, separated on three main use cases: notification channel, 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
task(doc): Detailed notification channel and internal messages
task(doc): General update of CallHandling flow
task(doc): Styles and fixed for call handling
task(doc): Separated FLOW for Notification channel API
task(doc): Included webhook option and some fixes
task(doc): fix title notification channel
task(doc): Flow detailed status and updated paths
task(doc): Updated sessionID and remove MoMs
task(doc): Improves notes on notification channels
task(doc): Included extra detail on PRACK and UPDATE

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

Copy link
Collaborator

@TEF-RicardoSerr TEF-RicardoSerr left a comment

Choose a reason for hiding this comment

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

LGTM. approved as per last meeting

@TEF-RicardoSerr TEF-RicardoSerr merged commit 2805cfd into camaraproject:main Jun 21, 2024
1 check failed
@stroncoso-quobis stroncoso-quobis deleted the doc/uml-diagrams branch July 16, 2024 16:32
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.

Describe the callflow for using these APIs
2 participants