Skip to content

Commit

Permalink
Updated diagrams from beta
Browse files Browse the repository at this point in the history
  • Loading branch information
atovpeko committed Dec 22, 2023
1 parent 02ce3dc commit b44c9f7
Show file tree
Hide file tree
Showing 14 changed files with 29 additions and 32 deletions.
20 changes: 10 additions & 10 deletions assets/images/signaling/authentication-workflow.puml
Original file line number Diff line number Diff line change
Expand Up @@ -17,31 +17,31 @@ participant "Signaling" as API
end box

group Log in to Signaling using authentication
APP -> TS: Request an RTM token using:\n App Id, user Id
TS -> TS: Validate request against internal security\n and generate token
TS -> TS: Configure your token server using\n your App Id and App Certificate
APP -> TS: Request an RTM token using a user Id
TS -> TS: Validate request against internal security\n and generate a token
TS -> APP: Return RTM token to App
APP -> APP: Initiate the Signaling Engine using\n App Id, user Id and the RTM token
APP -> API: Log in to Signaling
APP -> APP: Initiate the Signaling Engine using\n the App Id
APP -> API: Log in to Signaling using\n the user Id and the RTM token
API -> API: Validate the token
API -> APP: Log in user, then trigger callback
end

group Join a stream channel
APP -> TS: Request an RTC token using:\n App Id, user Id, and stream channel name
APP -> TS: Request an RTC token using\n a user Id, and a stream channel name
TS -> TS: Validate request against internal security\n and generate token
TS -> APP: Return RTC token to App
APP -> API: Join a stream channel using\n channel name, user Id, and the RTC token
end

group Renew token
API -> APP: Trigger event: token privilege will expire
APP -> TS: Request an RTM token using:\n App Id, user ID
TS -> TS: Validate request against internal security\n and generate token
API -> APP: Trigger event:\n token privilege will expire
APP -> TS: Request an RTM token using\n the user ID
TS -> TS: Validate request against internal security\n and generate a token
TS -> APP: Return RTM token to App
API <- APP: Send RTM token to Signaling with a \ncall to renew token
API -> API: Validate the token
API -> APP: Trigger callback
end

@enduml

@enduml
2 changes: 1 addition & 1 deletion assets/images/signaling/authentication-workflow.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion assets/images/signaling/cloud-proxy.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion assets/images/signaling/data-encryption.puml
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ APP <-> API: Join a channel
APP <-> API: Communicate over an\n encrypted data stream


@enduml
@enduml
2 changes: 1 addition & 1 deletion assets/images/signaling/data-encryption.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions assets/images/signaling/get-started-workflow.puml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ APP -> API: Log in to Signaling
end

group Messages

USR -> APP: Subscribe to a channel
APP -> API: signalingEngine.subscribe
USR -> APP: Publish message
APP -> API: signalingEngine.publish
APP -> APP: Listen for message events
Expand All @@ -34,5 +35,4 @@ USR -> APP: Log out
APP -> API: Log out of Signaling
end

@enduml

@enduml
2 changes: 1 addition & 1 deletion assets/images/signaling/get-started-workflow.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 1 addition & 2 deletions assets/images/signaling/presence-workflow.puml
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,4 @@ USR -> APP: Log out
APP -> API: Log out of Signaling
end

@enduml

@enduml
2 changes: 1 addition & 1 deletion assets/images/signaling/presence-workflow.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 1 addition & 2 deletions assets/images/signaling/signaling-metadata-workflow.puml
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,4 @@ APP -> API: Unsubscribe from user metadata update notifications
APP -> API: Log out of Signaling
end

@enduml

@enduml
2 changes: 1 addition & 1 deletion assets/images/signaling/signaling-metadata-workflow.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 5 additions & 6 deletions assets/images/signaling/stream-channel-workflow.puml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ end

group Channel

USR -> APP: Create or join channel
USR -> APP: Create stream channel
APP <-> API: Create channel or add user to channel
USR -> APP: Subscribe to a channel
API <-> APP: Channel events
Expand All @@ -35,10 +35,10 @@ API <-> APP: Topic events
group Messages

USR -> APP: Send message
APP -> API: sendMessageToTopic
APP -> API: Publish message to topic

API -> APP: MessageFromTopic
APP -> APP: listen for message events
API -> APP: Message from topic
APP -> APP: Listen for message events
APP -> USR: Receive message
end
USR -> APP: Leave topic
Expand All @@ -62,5 +62,4 @@ USR -> APP: Log out
APP -> API: Log out of Signaling
end

@enduml

@enduml
2 changes: 1 addition & 1 deletion assets/images/signaling/stream-channel-workflow.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion signaling/overview/pricing.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Pricing
sidebar_position: 1
sidebar_position: 3
description: >
Provides you with information on billing, fee deductions, free-of-charge policy, and any suspension to your account based on the account type.
---
Expand Down

0 comments on commit b44c9f7

Please sign in to comment.