Skip to content

Commit 31b0854

Browse files
transition from MDX v1 to v3 for Docusaurus v3 upgrade.
1 parent 418b34f commit 31b0854

File tree

92 files changed

+273
-184
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+273
-184
lines changed

docs/agent-bridging/spec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Desktop Agent Bridging is an experimental feature added to FDC3 in 2.1, hence, i
1010

1111
:::
1212

13-
<!-- ## TODO list
13+
\<!-- ## TODO list
1414

1515
* Expand on how the DAB should create the JWT token (and its claims, which must change to avoid replay attacks) which it sends out in the `hello` message for DAs to validate.
1616
* Link to BackPlane project somewhere

docs/api/ref/DesktopAgent.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1476,7 +1476,7 @@ Not implemented
14761476
</TabItem>
14771477
</Tabs>
14781478
1479-
Adds a listener for incoming context broadcasts from the Desktop Agent. Provided for backwards compatibility with versions FDC3 standard <2.0.
1479+
Adds a listener for incoming context broadcasts from the Desktop Agent. Provided for backwards compatibility with versions FDC3 standard\<2.0.
14801480
14811481
**See also:**
14821482
@@ -1550,7 +1550,7 @@ Not implemented
15501550
</TabItem>
15511551
</Tabs>
15521552
1553-
Version of `open` that launches an app by name rather than `AppIdentifier`. Provided for backwards compatibility with versions of the FDC3 Standard <2.0.
1553+
Version of `open` that launches an app by name rather than `AppIdentifier`. Provided for backwards compatibility with versions of the FDC3 Standard\<2.0.
15541554
15551555
**See also:**
15561556
@@ -1575,7 +1575,7 @@ Not implemented
15751575
</TabItem>
15761576
</Tabs>
15771577
1578-
Version of `raiseIntent` that targets an app by name rather than `AppIdentifier`. Provided for backwards compatibility with versions of the FDC3 Standard <2.0.
1578+
Version of `raiseIntent` that targets an app by name rather than `AppIdentifier`. Provided for backwards compatibility with versions of the FDC3 Standard\<2.0.
15791579
15801580
**See also:**
15811581
@@ -1600,7 +1600,7 @@ Not implemented
16001600
</TabItem>
16011601
</Tabs>
16021602
1603-
Version of `raiseIntentForContext` that targets an app by name rather than `AppIdentifier`. Provided for backwards compatibility with versions of the FDC3 Standard <2.0.
1603+
Version of `raiseIntentForContext` that targets an app by name rather than `AppIdentifier`. Provided for backwards compatibility with versions of the FDC3 Standard\<2.0.
16041604
16051605
**See also:**
16061606

docs/api/ref/Metadata.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ For each intent, it reference the applications that support that intent.
6565
interface AppMetadata extends AppIdentifier {
6666
/**
6767
* The 'friendly' app name. This field was used with the `open` and
68-
* `raiseIntent` calls in FDC3 <2.0, which now require an `AppIdentifier`
68+
* `raiseIntent` calls in FDC3\<2.0, which now require an `AppIdentifier`
6969
* with `appId` set.
7070
*
7171
* Note that for display purposes the `title` field should be used, if set,

docs/api/spec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: API Overview (next)
77
import Tabs from '@theme/Tabs';
88
import TabItem from '@theme/TabItem';
99

10-
The role of FDC3 API is to establish a baseline interface for interoperability between applications. Because FDC3 is largely an agreement between existing platforms and applications, standards should be optimized for ease of adoption rather than functional completeness. Functionality absent from a FDC3 specification is in no way a commentary on its importance.
10+
The role of FDC3 API is to establish a baseline interface for interoperability between applications. Because FDC3 is largely an agreement between existing platforms and applications, standards should be optimized for ease of adoption rather than functional completeness. Functionality absent from a FDC3 specification is in no way a commentary on its importance.
1111

1212
The following sections examine the API's use-cases and core concepts. The API is fully defined in both subsequent pages of this Part and a full set of TypeScript definitions in the [src](https://github.com/finos/FDC3/tree/main/src/api) directory of the [FDC3 GitHub repository](https://github.com/finos/FDC3/).
1313

docs/app-directory/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ A launcher can then easily construct a URI by:
138138
3. URI port is default `https/443`, but can be overridden by the launcher
139139
4. URI url is by default `/api/appd/(version)/apps` . Calls that are made without version MUST automatically default to latest, i.e. `/api/appd/apps/app1` should return the same result as `/api/appd/v2/apps/app1".
140140

141-
The resulting URI to retrieve application data for `app1` would be <https://appd.foo.com/api/appd/v2/apps/[email protected]>
141+
The resulting URI to retrieve application data for `app1` would be https://appd.foo.com/api/appd/v2/apps/[email protected] [https://appd.foo.com/api/appd/v2/apps/[email protected]](https://appd.foo.com/api/appd/v2/apps/[email protected])
142142

143143
### DNS/SRV Records
144144

docs/context/ref/Action.md

Lines changed: 56 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,36 @@ sidebar_label: Action
88

99
A representation of an FDC3 Action (specified via a Context or Context & Intent) that can be inserted inside another object, for example a chat message.
1010

11-
The action may be completed by calling `fdc3.raiseIntent()` with the specified Intent and Context, or, if only a context is specified, by calling `fdc3.raiseIntentForContext()` (which the Desktop Agent will resolve by presenting the user with a list of available Intents for the Context).
11+
The action may be completed by calling:
12+
- `fdc3.raiseIntent()` with the specified Intent and Context
13+
- `fdc3.raiseIntentForContext()` if only a context is specified, (which the Desktop Agent will resolve by presenting the user with a list of available Intents for the Context).
14+
- `channel.broadcast()` with the specified Context, if the `broadcast` action has been defined.
1215

1316
Accepts an optional `app` parameter in order to specify a specific app.
1417

1518
## Schema
1619

17-
<https://fdc3.finos.org/schemas/next/context/action.schema.json> ([github](https://github.com/finos/FDC3/tree/main/schemas/context/action.schema.json))
20+
[https://fdc3.finos.org/schemas/next/context/action.schema.json](https://fdc3.finos.org/schemas/next/context/action.schema.json) ([github](https://github.com/finos/FDC3/tree/main/schemas/context/action.schema.json))
1821

1922
## Type
2023

2124
`fdc3.action`
2225

2326
## Properties
2427

28+
<details>
29+
<summary><code>action</code></summary>
30+
31+
**type**: `string` with values:
32+
- `broadcast`,
33+
- `raiseIntent`
34+
35+
The **action** field indicates the type of action:
36+
- **raiseIntent** : If no action or `raiseIntent` is specified, then `fdc3.raiseIntent` or `fdc3.raiseIntentForContext` will be called with the specified context (and intent if given).
37+
- **broadcast** : If `broadcast` and a `channelId` are specified then `fdc3.getOrCreateChannel(channelId)` is called to retrieve the channel and broadcast the context to it with `channel.broadcast(context)`. If no `channelId` has been specified, the context should be broadcast to the current channel (`fdc3.broadcast()`)
38+
39+
</details>
40+
2541
<details>
2642
<summary><code>title</code> <strong>(required)</strong></summary>
2743

@@ -50,20 +66,30 @@ A context object with which the action will be performed
5066

5167
</details>
5268

69+
<details>
70+
<summary><code>channelId</code></summary>
71+
72+
**type**: `string`
73+
74+
Optional channel on which to broadcast the context. The `channelId` property is ignored unless the `action` is broadcast.
75+
76+
</details>
77+
5378
<details>
5479
<summary><code>app</code></summary>
5580

5681
**type**: api/AppIdentifier
5782

58-
An optional target application identifier that should perform the action
83+
An optional target application identifier that should perform the action. The `app` property is ignored unless the action is raiseIntent.
5984

6085
</details>
6186

62-
## Example
87+
## Examples
6388

6489
```json
6590
{
6691
"type": "fdc3.action",
92+
"action": "raiseIntent",
6793
"title": "Click to view Chart",
6894
"intent": "ViewChart",
6995
"context": {
@@ -90,3 +116,29 @@ An optional target application identifier that should perform the action
90116
}
91117
```
92118

119+
```json
120+
{
121+
"type": "fdc3.action",
122+
"action": "broadcast",
123+
"channelId": "Channel 1",
124+
"title": "Click to view Chart",
125+
"context": {
126+
"type": "fdc3.chart",
127+
"instruments": [
128+
{
129+
"type": "fdc3.instrument",
130+
"id": {
131+
"ticker": "EURUSD"
132+
}
133+
}
134+
],
135+
"range": {
136+
"type": "fdc3.dateRange",
137+
"starttime": "2020-09-01T08:00:00.000Z",
138+
"endtime": "2020-10-31T08:00:00.000Z"
139+
},
140+
"style": "candle"
141+
}
142+
}
143+
```
144+

docs/context/ref/BaseContext.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar_label: BaseContext
88

99
## Schema
1010

11-
<https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json>
11+
https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json [https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json](https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json)
1212

1313
## Type
1414

docs/context/ref/Chart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ In addition to handling requests to plot charts, a charting application may use
1717

1818
## Schema
1919

20-
<https://fdc3.finos.org/schemas/next/context/chart.schema.json> ([github](https://github.com/finos/FDC3/tree/main/schemas/context/chart.schema.json))
20+
[https://fdc3.finos.org/schemas/next/context/chart.schema.json](https://fdc3.finos.org/schemas/next/context/chart.schema.json) ([github](https://github.com/finos/FDC3/tree/main/schemas/context/chart.schema.json))
2121

2222
## Type
2323

docs/context/ref/ChatInitSettings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A collection of settings to start a new chat conversation
1010

1111
## Schema
1212

13-
<https://fdc3.finos.org/schemas/next/context/chatInitSettings.schema.json> ([github](https://github.com/finos/FDC3/tree/main/schemas/context/chatInitSettings.schema.json))
13+
[https://fdc3.finos.org/schemas/next/context/chatInitSettings.schema.json](https://fdc3.finos.org/schemas/next/context/chatInitSettings.schema.json) ([github](https://github.com/finos/FDC3/tree/main/schemas/context/chatInitSettings.schema.json))
1414

1515
## Type
1616

docs/context/ref/ChatMessage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A context representing a chat message. Typically used to send the message or to
1010

1111
## Schema
1212

13-
<https://fdc3.finos.org/schemas/next/context/chatMessage.schema.json> ([github](https://github.com/finos/FDC3/tree/main/schemas/context/chatMessage.schema.json))
13+
[https://fdc3.finos.org/schemas/next/context/chatMessage.schema.json](https://fdc3.finos.org/schemas/next/context/chatMessage.schema.json) ([github](https://github.com/finos/FDC3/tree/main/schemas/context/chatMessage.schema.json))
1414

1515
## Type
1616

0 commit comments

Comments
 (0)