Skip to content

Commit 05745af

Browse files
fix markdown file issues
1 parent 31b0854 commit 05745af

Some content is hidden

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

61 files changed

+375
-314
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: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ interface DesktopAgent {
4747
getCurrentChannel() : Promise<Channel | null>;
4848
leaveCurrentChannel() : Promise<void>;
4949

50-
// non-context events
50+
// non-context events
5151
addEventListener(type: FDC3EventTypes | null, handler: EventHandler): Promise<Listener>;
5252

5353
//implementation info
@@ -145,7 +145,7 @@ const listener = await fdc3.addContextListener(null, context => { ... });
145145
const contactListener = await fdc3.addContextListener('fdc3.contact', contact => { ... });
146146

147147
// listener that logs metadata for the message a specific type
148-
const contactListener = await fdc3.addContextListener('fdc3.contact', (contact, metadata) => {
148+
const contactListener = await fdc3.addContextListener('fdc3.contact', (contact, metadata) => {
149149
console.log(`Received context message\nContext: ${contact}\nOriginating app: ${metadata?.source}`);
150150
//do something else with the context
151151
});
@@ -210,7 +210,7 @@ Whenever the handler function is called it will be passed an event object with d
210210
const listener = await fdc3.addEventListener(null, event => { ... });
211211
212212
// listener for a specific event type that logs its details
213-
const userChannelChangedListener = await fdc3.addEventListener("userChannelChanged ", event => {
213+
const userChannelChangedListener = await fdc3.addEventListener("userChannelChanged ", event => {
214214
console.log(`Received event ${event.type}\n\tDetails: ${event.details}`);
215215
//do something else with the event
216216
});
@@ -277,7 +277,7 @@ const listener = fdc3.addIntentListener('StartChat', context => {
277277
});
278278
279279
//Handle a raised intent and log the originating app metadata
280-
const listener = fdc3.addIntentListener('StartChat', (contact, metadata) => {
280+
const listener = fdc3.addIntentListener('StartChat', (contact, metadata) => {
281281
console.log(`Received intent StartChat\nContext: ${contact}\nOriginating app: ${metadata?.source}`);
282282
return;
283283
});
@@ -492,7 +492,7 @@ _desktopAgent.AddIntentListener<Instrument>("QuoteStream", async (context, metad
492492
var disconnectListener = channel.OnDisconnect(() => {
493493
_feed.stop(symbol);
494494
});
495-
495+
496496
return channel;
497497
});
498498
```
@@ -599,8 +599,8 @@ const appIntent = await fdc3.findIntent("StartChat");
599599
// {
600600
// intent: { name: "StartChat" },
601601
// apps: [
602-
// { appId: "Skype" },
603-
// { appId: "Symphony" },
602+
// { appId: "Skype" },
603+
// { appId: "Symphony" },
604604
// { appId: "Slack" }
605605
// ]
606606
// }
@@ -610,14 +610,14 @@ await fdc3.raiseIntent(appIntent.intent.name, context, appIntent.apps[0]);
610610
611611
//later, we want to raise 'StartChat' intent again
612612
const appIntent = await fdc3.findIntent("StartChat");
613-
// returns an AppIntent, but with multiple options for resolution,
613+
// returns an AppIntent, but with multiple options for resolution,
614614
// which includes an existing instance of an application:
615615
// {
616616
// intent: { name: "StartChat" },
617617
// apps: [
618-
// { appId: "Skype" },
619-
// { appId: "Symphony" },
620-
// { appId: "Symphony", instanceId: "93d2fe3e-a66c-41e1-b80b-246b87120859" },
618+
// { appId: "Skype" },
619+
// { appId: "Symphony" },
620+
// { appId: "Symphony", instanceId: "93d2fe3e-a66c-41e1-b80b-246b87120859" },
621621
// { appId: "Slack" }
622622
// ]
623623
```
@@ -742,11 +742,11 @@ const appIntents = await fdc3.findIntentsByContext(context);
742742
// apps: [{ appId: "Skype" }]
743743
// },
744744
// {
745-
// intent: { name: "StartChat" },
745+
// intent: { name: "StartChat" },
746746
// apps: [
747-
// { appId: "Skype" },
748-
// { appId: "Symphony" },
749-
// { appId: "Symphony", instanceId: "93d2fe3e-a66c-41e1-b80b-246b87120859" },
747+
// { appId: "Skype" },
748+
// { appId: "Symphony" },
749+
// { appId: "Symphony", instanceId: "93d2fe3e-a66c-41e1-b80b-246b87120859" },
750750
// { appId: "Slack" }
751751
// ]
752752
// },
@@ -779,7 +779,7 @@ const appIntentsForType = await fdc3.findIntentsByContext(context, "fdc3.Contact
779779
// intent: { name: "ViewContact" },
780780
// apps: [{ appId: "Symphony" }, { appId: "MyCRM", resultType: "fdc3.ContactList"}]
781781
// }];
782-
782+
783783
// select a particular intent to raise
784784
const startChat = appIntents[1];
785785
@@ -1259,7 +1259,7 @@ If an error occurs while opening the app, the promise MUST be rejected with an `
12591259
let appIdentifier = { appId: 'myApp-v1.0.1' };
12601260
let instanceIdentifier = await fdc3.open(appIdentifier);
12611261
1262-
// Open an app with context
1262+
// Open an app with context
12631263
let instanceIdentifier = await fdc3.open(appIdentifier, context);
12641264
```
12651265
@@ -1271,7 +1271,7 @@ let instanceIdentifier = await fdc3.open(appIdentifier, context);
12711271
var appIdentifier = new AppIdentifier("myApp-v1.0.1");
12721272
var instanceIdentifier = await _desktopAgent.Open(appIdentifier);
12731273
1274-
// Open an app with context
1274+
// Open an app with context
12751275
var instanceIdentifier = await _desktopAgent.Open(appIdentifier, context);
12761276
```
12771277
@@ -1307,7 +1307,7 @@ Task<IIntentResolution> RaiseIntent(string intent, IContext context, IAppIdentif
13071307
Raises a specific intent for resolution against apps registered with the desktop agent.
13081308
13091309
The desktop agent MUST resolve the correct app to target based on the provided intent name and context data. If multiple matching apps are found, a method for resolving the intent to a target app, such as presenting the user with a resolver UI allowing them to pick an app, SHOULD be provided.
1310-
Alternatively, the specific app or app instance to target can also be provided. A list of valid target applications and instances can be retrieved via [`findIntent`](DesktopAgent#findintent).
1310+
Alternatively, the specific app or app instance to target can also be provided. A list of valid target applications and instances can be retrieved via [`findIntent`](DesktopAgent#findintent).
13111311
13121312
If a target app for the intent cannot be found with the criteria provided or the user either closes the resolver UI or otherwise cancels resolution, the promise MUST be rejected with an `Error` object with a `message` chosen from the [`ResolveError`](Errors#resolveerror) enumeration, or (if connected to a Desktop Agent Bridge) the [`BridgingError`](Errors#bridgingerror) enumeration. If a specific target `app` parameter was set, but either the app or app instance is not available, the promise MUST be rejected with an `Error` object with either the `ResolveError.TargetAppUnavailable` or `ResolveError.TargetInstanceUnavailable` string as its `message`. If an invalid context object is passed as an argument the promise MUST be rejected with an `Error` object with the [`ResolveError.MalformedContext`](Errors#resolveerror) string as its `message`.
13131313
@@ -1348,7 +1348,7 @@ try {
13481348
} else {
13491349
console.error(`${resolution.source} didn't return anything`
13501350
}
1351-
}
1351+
}
13521352
catch (error: ResultError) {
13531353
console.error(`${resolution.source} returned a result error: ${error}`);
13541354
}
@@ -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 &lt;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 &lt;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 &lt;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 &lt;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: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ knowledge of the AppD instance location.
9191

9292
### Authentication and Entitlements
9393

94-
The AppD API specification defines the optional use of an access token to identify the requesting user/launcher and implement authorizations which may affect appD API responses. For example, different subsets of the full list of applications may be returned for different users depending on their role in an organization.
94+
The AppD API specification defines the optional use of an access token to identify the requesting user/launcher and implement authorizations which may affect appD API responses. For example, different subsets of the full list of applications may be returned for different users depending on their role in an organization.
9595

9696
The specification does not define or make mandatory any authorizations or roles that a provider or enterprise can define.
9797

@@ -116,7 +116,7 @@ However, in order to do so, you must first discover the location of an app direc
116116
Three methods for discovering app directory services are defined in this Standard:
117117

118118
1. **Static configuration:** Statically defined URI records for use within client applications (typically a Desktop Agent implementation) directly.
119-
2. **Fully-qualified appID namespace syntax host resolution:** Discovery of the appD location using a fully qualified application ID (appId) domain name.
119+
2. **Fully-qualified appID namespace syntax host resolution:** Discovery of the appD location using a fully qualified application ID (appId) domain name.
120120
3. **DNS lookup by domain name:** Discovery of the appD location using a domain name to lookup DNS SRV records identifying the host server location and TCP port. ([RFC2782](https://tools.ietf.org/html/rfc2782))
121121

122122
App directory service host discovery implementations SHOULD support each of these methods and MUST support at least static configuration.
@@ -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] [https://appd.foo.com/api/appd/v2/apps/[email protected]](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])
142142

143143
### DNS/SRV Records
144144

docs/context/ref/BaseContext.md

Lines changed: 1 addition & 2 deletions
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 [https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json](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)
1212

1313
## Type
1414

@@ -29,4 +29,3 @@ https://github.com/finos/FDC3/tree/main/schemas/context/context.schema.json [htt
2929
**type**: `object`
3030

3131
</details>
32-

docs/context/ref/Context.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ hide_title: true
66
---
77
# `Context`
88

9-
The `fdc3.context` type defines the basic contract or "shape" for all data exchanged by FDC3 operations. As such, it is not
9+
The `fdc3.context` type defines the basic contract or "shape" for all data exchanged by FDC3 operations. As such, it is not
1010
really meant to be used on its own, but is imported by more specific type definitions (standardised or custom) to provide
1111
the structure and properties shared by all FDC3 context data types.
1212

@@ -24,7 +24,7 @@ can be expected to have, but this can always be extended with custom fields as a
2424

2525
## Schema
2626

27-
https://fdc3.finos.org/schemas/next/context/context.schema.json [https://fdc3.finos.org/schemas/next/context/context.schema.json](https://fdc3.finos.org/schemas/next/context/context.schema.json)
27+
[https://fdc3.finos.org/schemas/next/context/context.schema.json](https://fdc3.finos.org/schemas/next/context/context.schema.json)
2828

2929
## Details
3030

docs/context/ref/DocumentedContext.md

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

99
## Schema
1010

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)
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)
1212

1313
## Type
1414

docs/context/spec.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ or in JSON Schema as:
9797

9898
:::note
9999

100-
This is a simplified version of the schema for illustrative purposes, the fully documented Context schema, which is composed with other FDC3 Standard context schemas, can be found at: https://fdc3.finos.org/schemas/next/context/context.schema.json [https://fdc3.finos.org/schemas/next/context/context.schema.json](https://fdc3.finos.org/schemas/next/context/context.schema.json).
100+
This is a simplified version of the schema for illustrative purposes, the fully documented Context schema, which is composed with other FDC3 Standard context schemas, can be found at: [https://fdc3.finos.org/schemas/next/context/context.schema.json](https://fdc3.finos.org/schemas/next/context/context.schema.json).
101101

102102
:::
103103

@@ -360,8 +360,8 @@ e.g. as a JSON payload:
360360
{
361361
"type" : "fdc3.instrument",
362362
"name" : "Apple",
363-
"id" :
364-
{
363+
"id" :
364+
{
365365
"ticker" : "aapl",
366366
"ISIN" : "US0378331005",
367367
"CUSIP" : "037833100"

docs/guides/submit-new-intent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ To run the website locally
2121

2222
```yarn start```
2323

24-
This will open the home page or browse to https://localhost:3000 [https://localhost:3000](https://localhost:3000)
24+
This will open the home page or browse to [https://localhost:3000](https://localhost:3000)
2525

2626
Note that the page opens on the current release version of the docs and you will be changing the latest version. Click the version selector in the top left hand corner
2727

0 commit comments

Comments
 (0)