From 48e5dd7576eb294518927027adc5714df938b9a5 Mon Sep 17 00:00:00 2001 From: Chris Watson <47246322+WatsonCIQ@users.noreply.github.com> Date: Thu, 10 Mar 2022 12:47:33 +0000 Subject: [PATCH] small formatting changes --- docs/api-bridging/spec.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/api-bridging/spec.md b/docs/api-bridging/spec.md index 78a9acf5e..0621bd64d 100644 --- a/docs/api-bridging/spec.md +++ b/docs/api-bridging/spec.md @@ -15,7 +15,7 @@ Need to product some description of a protocol, to be used over a websocket, for ## Individual message exchanges ### For broadcasts on channels Only needs a single message (no response) -Somebody does `fdc3.broadcast(contextObj); `or` \ +Somebody does `fdc3.broadcast(contextObj); `or` (await fdc3.getOrCreateChannel(channelName)).broadcast(contextObj)` ``` { @@ -26,7 +26,7 @@ Somebody does `fdc3.broadcast(contextObj); `or` \ context: contxtObj } ``` - \ + (server to add agent field) ### findIntent ``` @@ -43,10 +43,9 @@ findIntent(intent: string, context?: Context): Promise; sourceAgent?: string //optional as filled in by server } ``` -E.g. Call outward to other desktop agents (sent from A -> C \ - \ -`{` +E.g. Call outward to other desktop agents (sent from A -> C ``` +{ requestGuid: "4dd60b3b-9835-4cab-870c-6b9b099ed7ae", timestamp: 2020-03-..., type: "findIntentRequest", @@ -78,7 +77,7 @@ And repeated from C -> B as: targetAgent: string } ``` - \ + Server should augment the AppIntent.apps[AppMetadata] objects with the desktop agent as well as the sourceAgent field. targetAgent field should always be filled in with the sourceAgent of the request \ E.g. Normal response from:agent A (where the request was raised) - websocket client @@ -90,9 +89,10 @@ Normal response from:agent A (where the request was raised) - websocket client ] } ``` -Desktop agent B - websocket client \ -`{` +Desktop agent B - websocket client + ``` +{ intent: { name: "StartChat", displayName: "Chat" }, apps: [ { name: "Skype" }, @@ -132,7 +132,7 @@ Sent back over the bridge (by Agent B - which happens to be a websocket client) targetAgent: "agent-A" } ``` - \ + Which gets repeated by a server (agent-C) in augmented form as: ``` {