From f8f8290fb3fc601390d93a1ab9e2fab39348bf36 Mon Sep 17 00:00:00 2001 From: Kris West Date: Mon, 24 Jul 2023 17:21:24 +0100 Subject: [PATCH 1/3] Add the app to each reference page mermaid diagram to clarify how message exchanges work --- .../ref/PrivateChannel.broadcast.md | 8 ++++++-- .../ref/PrivateChannel.eventListenerAdded.md | 8 ++++++-- .../PrivateChannel.eventListenerRemoved.md | 4 ++++ .../PrivateChannel.onAddContextListener.md | 8 ++++++-- .../ref/PrivateChannel.onDisconnect.md | 8 ++++++-- .../ref/PrivateChannel.onUnsubscribe.md | 4 ++++ docs/agent-bridging/ref/broadcast.md | 10 +++++++--- docs/agent-bridging/ref/findInstances.md | 13 +++++++++---- docs/agent-bridging/ref/findIntent.md | 17 +++++++++++------ .../ref/findIntentsByContext.md | 17 +++++++++++------ docs/agent-bridging/ref/getAppMetadata.md | 11 ++++++++--- docs/agent-bridging/ref/open.md | 13 +++++++++---- docs/agent-bridging/ref/raiseIntent.md | 19 +++++++++++++------ 13 files changed, 100 insertions(+), 40 deletions(-) diff --git a/docs/agent-bridging/ref/PrivateChannel.broadcast.md b/docs/agent-bridging/ref/PrivateChannel.broadcast.md index 30c389d6b..175dc797a 100644 --- a/docs/agent-bridging/ref/PrivateChannel.broadcast.md +++ b/docs/agent-bridging/ref/PrivateChannel.broadcast.md @@ -20,12 +20,16 @@ Some additional tracking of PrivateChannel metadata is required on the Desktop A ```mermaid sequenceDiagram + box Desktop Agent A + participant AA as App A participant DA as Desktop Agent A + end participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - DA ->>+ DAB: PrivateChannel.broadcast - DAB ->>+ DB: PrivateChannel.broadcast + AA -->> DA: privateChannel.broadcast() + DA ->> DAB: PrivateChannel.broadcast + DAB ->> DB: PrivateChannel.broadcast ``` ## Request format diff --git a/docs/agent-bridging/ref/PrivateChannel.eventListenerAdded.md b/docs/agent-bridging/ref/PrivateChannel.eventListenerAdded.md index afca79c01..3fe949cf6 100644 --- a/docs/agent-bridging/ref/PrivateChannel.eventListenerAdded.md +++ b/docs/agent-bridging/ref/PrivateChannel.eventListenerAdded.md @@ -24,12 +24,16 @@ Private channels support a number of additional event listeners (`onAddContextLi ```mermaid sequenceDiagram + box Desktop Agent A + participant AA as App A participant DA as Desktop Agent A + end participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - DA ->>+ DAB: PrivateChannel.eventListenerAdded - DAB ->>+ DB: PrivateChannel.eventListenerAdded + AA -->> DA: adds an event listener + DA ->> DAB: PrivateChannel.eventListenerAdded + DAB ->> DB: PrivateChannel.eventListenerAdded ``` ## Request format diff --git a/docs/agent-bridging/ref/PrivateChannel.eventListenerRemoved.md b/docs/agent-bridging/ref/PrivateChannel.eventListenerRemoved.md index 402e21a86..0b4c4adc6 100644 --- a/docs/agent-bridging/ref/PrivateChannel.eventListenerRemoved.md +++ b/docs/agent-bridging/ref/PrivateChannel.eventListenerRemoved.md @@ -27,10 +27,14 @@ Private channels support a number of additional event listeners (`onAddContextLi ```mermaid sequenceDiagram + box Desktop Agent A + participant AA as App A participant DA as Desktop Agent A + end participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C + AA -->> DA: removes an event listener DA ->>+ DAB: PrivateChannel.eventListenerRemoved DAB ->>+ DB: PrivateChannel.eventListenerRemoved ``` diff --git a/docs/agent-bridging/ref/PrivateChannel.onAddContextListener.md b/docs/agent-bridging/ref/PrivateChannel.onAddContextListener.md index 2c55b7890..e623fb1ff 100644 --- a/docs/agent-bridging/ref/PrivateChannel.onAddContextListener.md +++ b/docs/agent-bridging/ref/PrivateChannel.onAddContextListener.md @@ -22,12 +22,16 @@ When a `ContextListener` is added to a `PrivateChannel` any applications that ha ```mermaid sequenceDiagram + box Desktop Agent A + participant AA as App A participant DA as Desktop Agent A + end participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - DA ->>+ DAB: PrivateChannel.onAddContextListener - DAB ->>+ DB: PrivateChannel.onAddContextListener + AA -->> DA: privateChannel.addContextListener() + DA ->> DAB: PrivateChannel.onAddContextListener + DAB ->> DB: PrivateChannel.onAddContextListener ``` ## Request format diff --git a/docs/agent-bridging/ref/PrivateChannel.onDisconnect.md b/docs/agent-bridging/ref/PrivateChannel.onDisconnect.md index ccd73ce69..1aa943dd4 100644 --- a/docs/agent-bridging/ref/PrivateChannel.onDisconnect.md +++ b/docs/agent-bridging/ref/PrivateChannel.onDisconnect.md @@ -22,12 +22,16 @@ When the `disconnect` function is is called on a `PrivateChannel` any applicatio ```mermaid sequenceDiagram + box Desktop Agent A + participant AA as App A + end participant DA as Desktop Agent A participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - DA ->>+ DAB: PrivateChannel.onDisconnect - DAB ->>+ DB: PrivateChannel.onDisconnect + AA -->> DA: privateChannel.disconnect() + DA ->> DAB: PrivateChannel.onDisconnect + DAB ->> DB: PrivateChannel.onDisconnect ``` ### Request message schemas diff --git a/docs/agent-bridging/ref/PrivateChannel.onUnsubscribe.md b/docs/agent-bridging/ref/PrivateChannel.onUnsubscribe.md index 6fd902543..2cabdfb26 100644 --- a/docs/agent-bridging/ref/PrivateChannel.onUnsubscribe.md +++ b/docs/agent-bridging/ref/PrivateChannel.onUnsubscribe.md @@ -25,10 +25,14 @@ When a `ContextListener` is removed from a `PrivateChannel` (via `listener.unsub ```mermaid sequenceDiagram + box Desktop Agent A + participant AA as App A participant DA as Desktop Agent A + end participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C + AA -->> DA: listener.unsubscribe() DA ->>+ DAB: PrivateChannel.onUnsubscribe DAB ->>+ DB: PrivateChannel.onUnsubscribe ``` diff --git a/docs/agent-bridging/ref/broadcast.md b/docs/agent-bridging/ref/broadcast.md index d657035e2..90477d1fd 100644 --- a/docs/agent-bridging/ref/broadcast.md +++ b/docs/agent-bridging/ref/broadcast.md @@ -33,13 +33,17 @@ or ```mermaid sequenceDiagram + box Desktop Agent A + participant AA as App A participant DA as Desktop Agent A + end participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - DA ->>+ DAB: broadcastRequest - DAB ->>+ DB: broadcastRequest - DAB ->>+ DC: broadcastRequest + AA -->> DA: fdc3.broadcast() / channel.broadcast() + DA ->> DAB: broadcastRequest + DAB ->> DB: broadcastRequest + DAB ->> DC: broadcastRequest ``` ## Request format diff --git a/docs/agent-bridging/ref/findInstances.md b/docs/agent-bridging/ref/findInstances.md index 7cf0cc2e5..9b3463de5 100644 --- a/docs/agent-bridging/ref/findInstances.md +++ b/docs/agent-bridging/ref/findInstances.md @@ -24,16 +24,21 @@ let instances = await fdc3.findInstances({appId: "MyAppId", desktopAgent: "agent ```mermaid sequenceDiagram + box Desktop Agent A + participant AA as App A participant DA as Desktop Agent A + end participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - DA ->>+ DAB: findInstancesRequest - DAB ->>+ DB: findInstancesRequest - DAB ->>+ DC: findInstancesRequest + AA -->> DA: fdc3.findInstances() + DA ->> DAB: findInstancesRequest + DAB ->> DB: findInstancesRequest + DAB ->> DC: findInstancesRequest DB ->> DAB: findInstancesResponse (B) DC ->> DAB: findInstancesResponse (C) - DAB -->>- DA: findInstancesResponse (B + C) + DAB ->> DA: findInstancesResponse (B + C) + DA -->> AA: resolve ``` ## Request format diff --git a/docs/agent-bridging/ref/findIntent.md b/docs/agent-bridging/ref/findIntent.md index 846873b97..f3168e296 100644 --- a/docs/agent-bridging/ref/findIntent.md +++ b/docs/agent-bridging/ref/findIntent.md @@ -20,16 +20,21 @@ let appIntent = await fdc3.findIntent("StartChat", context); ```mermaid sequenceDiagram + box Desktop Agent A + participant AA as App A participant DA as Desktop Agent A + end participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - DA ->>+ DAB: findIntentRequest - DAB ->>+ DB: findIntentRequest - DAB ->>+ DC: findIntentRequest - DB -->>- DAB: findIntentResponse (B) - DC -->>- DAB: findIntentResponse (C) - DAB -->>- DA: findIntentResponse (B + C) + AA -->> DA: fdc3.findIntent() + DA ->> DAB: findIntentRequest + DAB ->> DB: findIntentRequest + DAB ->> DC: findIntentRequest + DB ->> DAB: findIntentResponse (B) + DC ->> DAB: findIntentResponse (C) + DAB ->> DA: findIntentResponse (B + C) + DA -->> AA: resolve ``` ## Request format diff --git a/docs/agent-bridging/ref/findIntentsByContext.md b/docs/agent-bridging/ref/findIntentsByContext.md index 61e74352c..720ed072a 100644 --- a/docs/agent-bridging/ref/findIntentsByContext.md +++ b/docs/agent-bridging/ref/findIntentsByContext.md @@ -24,16 +24,21 @@ The message exchanges for this API call are nearly identical to that used for [` ```mermaid sequenceDiagram + box Desktop Agent A + participant AA as App A participant DA as Desktop Agent A + end participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - DA ->>+ DAB: findIntentsByContextRequest - DAB ->>+ DB: findIntentsByContextRequest - DAB ->>+ DC: findIntentsByContextRequest - DB -->>- DAB: findIntentsByContextResponse (B) - DC -->>- DAB: findIntentsByContextResponse (C) - DAB -->>- DA: findIntentsByContextResponse (B + C) + AA -->> DA: fdc3.findIntentsByContext + DA ->> DAB: findIntentsByContextRequest + DAB ->> DB: findIntentsByContextRequest + DAB ->> DC: findIntentsByContextRequest + DB ->> DAB: findIntentsByContextResponse (B) + DC ->> DAB: findIntentsByContextResponse (C) + DAB ->> DA: findIntentsByContextResponse (B + C) + DA -->> AA: resolve ``` ## Request format diff --git a/docs/agent-bridging/ref/getAppMetadata.md b/docs/agent-bridging/ref/getAppMetadata.md index e415926ef..a66267b72 100644 --- a/docs/agent-bridging/ref/getAppMetadata.md +++ b/docs/agent-bridging/ref/getAppMetadata.md @@ -25,14 +25,19 @@ let appMetadata = await fdc3.getAppMetadata(appIdentifier); ```mermaid sequenceDiagram + box Desktop Agent A + participant AA as App A participant DA as Desktop Agent A + end participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - DA ->>+ DAB: getAppMetadataRequest - DAB ->>+ DB: getAppMetadataRequest + AA -->> DA: fdc3.getAppMetadata() + DA ->> DAB: getAppMetadataRequest + DAB ->> DB: getAppMetadataRequest DB ->> DAB: getAppMetadataResponse (B) - DAB -->>- DA: getAppMetadataResponse (B) + DAB ->> DA: getAppMetadataResponse (B) + DA -->> AA: resolve ``` ## Request format diff --git a/docs/agent-bridging/ref/open.md b/docs/agent-bridging/ref/open.md index 32c40b8f9..0ea6e05c5 100644 --- a/docs/agent-bridging/ref/open.md +++ b/docs/agent-bridging/ref/open.md @@ -40,14 +40,19 @@ If the remote Desktop Agent is not currently connected from the bridge, the [`Op ```mermaid sequenceDiagram + box Desktop Agent A + participant AA as App A participant DA as Desktop Agent A + end participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - DA ->>+ DAB: openRequest - DAB ->>+ DB: openRequest - DB -->>- DAB: openResponse - DAB -->>- DA: openResponse + AA -->> DA: fdc3.open() + DA ->> DAB: openRequest + DAB ->> DB: openRequest + DB ->> DAB: openResponse + DAB ->> DA: openResponse + DA -->> AA: resolve ``` ## Request format diff --git a/docs/agent-bridging/ref/raiseIntent.md b/docs/agent-bridging/ref/raiseIntent.md index 0819c3359..d94274783 100644 --- a/docs/agent-bridging/ref/raiseIntent.md +++ b/docs/agent-bridging/ref/raiseIntent.md @@ -51,16 +51,23 @@ Agent-C is not involved in the diagram below as the `raiseIntent` is always spec ```mermaid sequenceDiagram + box Desktop Agent A + participant AA as App A participant DA as Desktop Agent A + end participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - DA ->>+ DAB: raiseIntentRequest - DAB ->>+ DB: raiseIntentRequest - DB -->>- DAB: raiseIntentResponse - DAB -->>- DA: raiseIntentResponse - DB ->>+ DAB: raiseIntentResultResponse - DAB ->>+ DA: raiseIntentResultResponse + AA -->> DA: fdc3.raiseIntent + DA ->> DAB: raiseIntentRequest + DAB ->> DB: raiseIntentRequest + DB ->> DAB: raiseIntentResponse + DAB ->> DA: raiseIntentResponse + DA -->> AA: resolve (IntentResolution) + AA -->> DA: resolution.getResult() + DB ->> DAB: raiseIntentResultResponse + DAB ->> DA: raiseIntentResultResponse + DA -->> AA: resolve (IntentResult) ``` ## Request format From 0cb64f7eb8b330cc5ef282bd8b0f6aea8f303dfb Mon Sep 17 00:00:00 2001 From: Kris West Date: Mon, 24 Jul 2023 17:38:06 +0100 Subject: [PATCH 2/3] Changing arrow style for FDC3 API calls + adding expect type for promise resolution to mermaid diagrams --- docs/agent-bridging/ref/PrivateChannel.broadcast.md | 2 +- .../agent-bridging/ref/PrivateChannel.eventListenerAdded.md | 2 +- .../ref/PrivateChannel.eventListenerRemoved.md | 6 +++--- .../ref/PrivateChannel.onAddContextListener.md | 2 +- docs/agent-bridging/ref/PrivateChannel.onDisconnect.md | 2 +- docs/agent-bridging/ref/PrivateChannel.onUnsubscribe.md | 2 +- docs/agent-bridging/ref/broadcast.md | 2 +- docs/agent-bridging/ref/findInstances.md | 4 ++-- docs/agent-bridging/ref/findIntent.md | 4 ++-- docs/agent-bridging/ref/findIntentsByContext.md | 4 ++-- docs/agent-bridging/ref/getAppMetadata.md | 4 ++-- docs/agent-bridging/ref/open.md | 4 ++-- docs/agent-bridging/ref/raiseIntent.md | 6 +++--- 13 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/agent-bridging/ref/PrivateChannel.broadcast.md b/docs/agent-bridging/ref/PrivateChannel.broadcast.md index 175dc797a..51695afcf 100644 --- a/docs/agent-bridging/ref/PrivateChannel.broadcast.md +++ b/docs/agent-bridging/ref/PrivateChannel.broadcast.md @@ -27,7 +27,7 @@ sequenceDiagram participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - AA -->> DA: privateChannel.broadcast() + AA --) DA: privateChannel.broadcast() DA ->> DAB: PrivateChannel.broadcast DAB ->> DB: PrivateChannel.broadcast ``` diff --git a/docs/agent-bridging/ref/PrivateChannel.eventListenerAdded.md b/docs/agent-bridging/ref/PrivateChannel.eventListenerAdded.md index 3fe949cf6..11c905a35 100644 --- a/docs/agent-bridging/ref/PrivateChannel.eventListenerAdded.md +++ b/docs/agent-bridging/ref/PrivateChannel.eventListenerAdded.md @@ -31,7 +31,7 @@ sequenceDiagram participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - AA -->> DA: adds an event listener + AA --) DA: adds an event listener DA ->> DAB: PrivateChannel.eventListenerAdded DAB ->> DB: PrivateChannel.eventListenerAdded ``` diff --git a/docs/agent-bridging/ref/PrivateChannel.eventListenerRemoved.md b/docs/agent-bridging/ref/PrivateChannel.eventListenerRemoved.md index 0b4c4adc6..a051a8864 100644 --- a/docs/agent-bridging/ref/PrivateChannel.eventListenerRemoved.md +++ b/docs/agent-bridging/ref/PrivateChannel.eventListenerRemoved.md @@ -34,9 +34,9 @@ sequenceDiagram participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - AA -->> DA: removes an event listener - DA ->>+ DAB: PrivateChannel.eventListenerRemoved - DAB ->>+ DB: PrivateChannel.eventListenerRemoved + AA --) DA: removes an event listener + DA ->> DAB: PrivateChannel.eventListenerRemoved + DAB ->> DB: PrivateChannel.eventListenerRemoved ``` ## Request format diff --git a/docs/agent-bridging/ref/PrivateChannel.onAddContextListener.md b/docs/agent-bridging/ref/PrivateChannel.onAddContextListener.md index e623fb1ff..94365ac73 100644 --- a/docs/agent-bridging/ref/PrivateChannel.onAddContextListener.md +++ b/docs/agent-bridging/ref/PrivateChannel.onAddContextListener.md @@ -29,7 +29,7 @@ sequenceDiagram participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - AA -->> DA: privateChannel.addContextListener() + AA --) DA: privateChannel.addContextListener() DA ->> DAB: PrivateChannel.onAddContextListener DAB ->> DB: PrivateChannel.onAddContextListener ``` diff --git a/docs/agent-bridging/ref/PrivateChannel.onDisconnect.md b/docs/agent-bridging/ref/PrivateChannel.onDisconnect.md index 1aa943dd4..bba597b1e 100644 --- a/docs/agent-bridging/ref/PrivateChannel.onDisconnect.md +++ b/docs/agent-bridging/ref/PrivateChannel.onDisconnect.md @@ -29,7 +29,7 @@ sequenceDiagram participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - AA -->> DA: privateChannel.disconnect() + AA --) DA: privateChannel.disconnect() DA ->> DAB: PrivateChannel.onDisconnect DAB ->> DB: PrivateChannel.onDisconnect ``` diff --git a/docs/agent-bridging/ref/PrivateChannel.onUnsubscribe.md b/docs/agent-bridging/ref/PrivateChannel.onUnsubscribe.md index 2cabdfb26..07084c803 100644 --- a/docs/agent-bridging/ref/PrivateChannel.onUnsubscribe.md +++ b/docs/agent-bridging/ref/PrivateChannel.onUnsubscribe.md @@ -32,7 +32,7 @@ sequenceDiagram participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - AA -->> DA: listener.unsubscribe() + AA --) DA: listener.unsubscribe() DA ->>+ DAB: PrivateChannel.onUnsubscribe DAB ->>+ DB: PrivateChannel.onUnsubscribe ``` diff --git a/docs/agent-bridging/ref/broadcast.md b/docs/agent-bridging/ref/broadcast.md index 90477d1fd..0076d3c24 100644 --- a/docs/agent-bridging/ref/broadcast.md +++ b/docs/agent-bridging/ref/broadcast.md @@ -40,7 +40,7 @@ sequenceDiagram participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - AA -->> DA: fdc3.broadcast() / channel.broadcast() + AA --) DA: fdc3.broadcast() / channel.broadcast() DA ->> DAB: broadcastRequest DAB ->> DB: broadcastRequest DAB ->> DC: broadcastRequest diff --git a/docs/agent-bridging/ref/findInstances.md b/docs/agent-bridging/ref/findInstances.md index 9b3463de5..7ff228fcb 100644 --- a/docs/agent-bridging/ref/findInstances.md +++ b/docs/agent-bridging/ref/findInstances.md @@ -31,14 +31,14 @@ sequenceDiagram participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - AA -->> DA: fdc3.findInstances() + AA --) DA: fdc3.findInstances() DA ->> DAB: findInstancesRequest DAB ->> DB: findInstancesRequest DAB ->> DC: findInstancesRequest DB ->> DAB: findInstancesResponse (B) DC ->> DAB: findInstancesResponse (C) DAB ->> DA: findInstancesResponse (B + C) - DA -->> AA: resolve + DA --) AA: resolve (AppIdentifier[]) ``` ## Request format diff --git a/docs/agent-bridging/ref/findIntent.md b/docs/agent-bridging/ref/findIntent.md index f3168e296..8bda6ae2e 100644 --- a/docs/agent-bridging/ref/findIntent.md +++ b/docs/agent-bridging/ref/findIntent.md @@ -27,14 +27,14 @@ sequenceDiagram participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - AA -->> DA: fdc3.findIntent() + AA --) DA: fdc3.findIntent() DA ->> DAB: findIntentRequest DAB ->> DB: findIntentRequest DAB ->> DC: findIntentRequest DB ->> DAB: findIntentResponse (B) DC ->> DAB: findIntentResponse (C) DAB ->> DA: findIntentResponse (B + C) - DA -->> AA: resolve + DA --) AA: resolve (AppIntent) ``` ## Request format diff --git a/docs/agent-bridging/ref/findIntentsByContext.md b/docs/agent-bridging/ref/findIntentsByContext.md index 720ed072a..8a5035313 100644 --- a/docs/agent-bridging/ref/findIntentsByContext.md +++ b/docs/agent-bridging/ref/findIntentsByContext.md @@ -31,14 +31,14 @@ sequenceDiagram participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - AA -->> DA: fdc3.findIntentsByContext + AA --) DA: fdc3.findIntentsByContext DA ->> DAB: findIntentsByContextRequest DAB ->> DB: findIntentsByContextRequest DAB ->> DC: findIntentsByContextRequest DB ->> DAB: findIntentsByContextResponse (B) DC ->> DAB: findIntentsByContextResponse (C) DAB ->> DA: findIntentsByContextResponse (B + C) - DA -->> AA: resolve + DA --) AA: resolve (AppIntent[]) ``` ## Request format diff --git a/docs/agent-bridging/ref/getAppMetadata.md b/docs/agent-bridging/ref/getAppMetadata.md index a66267b72..9b30e5af4 100644 --- a/docs/agent-bridging/ref/getAppMetadata.md +++ b/docs/agent-bridging/ref/getAppMetadata.md @@ -32,12 +32,12 @@ sequenceDiagram participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - AA -->> DA: fdc3.getAppMetadata() + AA --) DA: fdc3.getAppMetadata() DA ->> DAB: getAppMetadataRequest DAB ->> DB: getAppMetadataRequest DB ->> DAB: getAppMetadataResponse (B) DAB ->> DA: getAppMetadataResponse (B) - DA -->> AA: resolve + DA --) AA: resolve (AppMetadata) ``` ## Request format diff --git a/docs/agent-bridging/ref/open.md b/docs/agent-bridging/ref/open.md index 0ea6e05c5..13d06034a 100644 --- a/docs/agent-bridging/ref/open.md +++ b/docs/agent-bridging/ref/open.md @@ -47,12 +47,12 @@ sequenceDiagram participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - AA -->> DA: fdc3.open() + AA --) DA: fdc3.open() DA ->> DAB: openRequest DAB ->> DB: openRequest DB ->> DAB: openResponse DAB ->> DA: openResponse - DA -->> AA: resolve + DA --) AA: resolve (AppIdentifier) ``` ## Request format diff --git a/docs/agent-bridging/ref/raiseIntent.md b/docs/agent-bridging/ref/raiseIntent.md index d94274783..f9c74753e 100644 --- a/docs/agent-bridging/ref/raiseIntent.md +++ b/docs/agent-bridging/ref/raiseIntent.md @@ -58,16 +58,16 @@ sequenceDiagram participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C - AA -->> DA: fdc3.raiseIntent + AA --) DA: fdc3.raiseIntent DA ->> DAB: raiseIntentRequest DAB ->> DB: raiseIntentRequest DB ->> DAB: raiseIntentResponse DAB ->> DA: raiseIntentResponse DA -->> AA: resolve (IntentResolution) - AA -->> DA: resolution.getResult() + AA --) DA: resolution.getResult() DB ->> DAB: raiseIntentResultResponse DAB ->> DA: raiseIntentResultResponse - DA -->> AA: resolve (IntentResult) + DA --) AA: resolve (IntentResult) ``` ## Request format From edcbb26724d2b3f0ffd8e23a651d1d13b74b829d Mon Sep 17 00:00:00 2001 From: Kris West Date: Mon, 24 Jul 2023 17:39:04 +0100 Subject: [PATCH 3/3] fix box in mermaid diagram --- docs/agent-bridging/ref/PrivateChannel.onDisconnect.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/agent-bridging/ref/PrivateChannel.onDisconnect.md b/docs/agent-bridging/ref/PrivateChannel.onDisconnect.md index bba597b1e..48387160d 100644 --- a/docs/agent-bridging/ref/PrivateChannel.onDisconnect.md +++ b/docs/agent-bridging/ref/PrivateChannel.onDisconnect.md @@ -24,8 +24,8 @@ When the `disconnect` function is is called on a `PrivateChannel` any applicatio sequenceDiagram box Desktop Agent A participant AA as App A - end participant DA as Desktop Agent A + end participant DAB as Desktop Agent Bridge participant DB as Desktop Agent B participant DC as Desktop Agent C