Skip to content

Commit df805e9

Browse files
Merge branch 'finos:master' into master
2 parents 6c0128f + 071be32 commit df805e9

25 files changed

Lines changed: 169 additions & 143 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
88

99
### Added
1010

11+
* Added clarification that `id` field values SHOULD always be strings to context schema definition (a restriction that can't easily be represented in the generated types). ([#1149](https://github.com/finos/FDC3/pull/1149))
12+
1113
### Changed
1214

1315
### Deprecated

docs/agent-bridging/ref/findIntent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ sequenceDiagram
4646

4747
### Example
4848

49-
Outward message to the DAB:
49+
Outward message to the DAB (with `intent` and `context` specified, but not `resultType`):
5050

5151
```json
5252
// agent-A -> DAB

docs/agent-bridging/spec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ The DA must then respond to the `hello` message with a `handshake` request to th
244244
* provides. The string must be a numeric semver version, e.g. 1.2 or 1.2.1. */
245245
fdc3Version: string,
246246
/** The name of the provider of the FDC3 Desktop Agent Implementation
247-
* (e.g.Finsemble, Glue42, OpenFin etc.). */
247+
* (e.g.Finsemble, io.Connect, OpenFin etc.). */
248248
provider: string,
249249
/** The version of the provider of the FDC3 Desktop Agent Implementation (e.g. 5.3.0). */
250250
providerVersion: string,

docs/api/ref/Metadata.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ interface ImplementationMetadata {
243243
readonly fdc3Version: string;
244244

245245
/** The name of the provider of the FDC3 Desktop Agent Implementation
246-
* (e.g.Finsemble, Glue42, OpenFin etc.).
246+
* (e.g. io.Connect, OpenFin etc.).
247247
*/
248248
readonly provider: string;
249249

docs/api/spec.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ A Desktop Agent is a desktop component (or aggregate of components) that serves
1717
Examples of Desktop Agents include:
1818

1919
- Autobahn
20-
- Finsemble
21-
- Glue42
20+
- io.Connect
2221
- OpenFin
2322
- Refinitiv Eikon
2423

@@ -226,7 +225,7 @@ As an alternative to raising a specific intent, you may also raise an unspecifie
226225

227226
### Intent Results
228227

229-
An optional [`IntentResult`](ref/Types#intentresult) may also be returned as output by an application handling an intent. Results maybe either a single `Context` object, or a `Channel` that may be used to send a stream of responses. The [`PrivateChannel`](ref/PrivateChannel) type is provided to support synchronization of data transmitted over returned channels, by allowing both parties to listen for events denoting subscription and unsubscription from the returned channel. `PrivateChannels` are only retrievable via [raising an intent](ref/DesktopAgent#raiseintent).
228+
An optional [`IntentResult`](ref/Types#intentresult) may also be returned as output by an application handling an intent. Results may be a single `Context` object, a `Channel` that may be used to send a stream of responses, or `void` (no result). The [`PrivateChannel`](ref/PrivateChannel) type is provided to support synchronization of data transmitted over returned channels, by allowing both parties to listen for events denoting subscription and unsubscription from the returned channel. `PrivateChannels` are only retrievable via [raising an intent](ref/DesktopAgent#raiseintent).
230229

231230
For example, an application handling a `CreateOrder` intent might return a context representing the order and including an ID, allowing the application that raised the intent to make further calls using that ID.
232231

docs/context/ref/Context.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,12 @@ derived types may require the name object as mandatory, depending on use case.
5454

5555
### `id` (optional)
5656

57-
Context data objects may include a set of equivalent key-value pairs that can be used to help applications
58-
identify and look up the context type they receive in their own domain. The idea behind this design is that applications can provide as many equivalent identifiers to a target application as possible, e.g. an instrument may be represented by an ISIN, CUSIP or Bloomberg identifier.
57+
Context data objects may include a set of equivalent key-value pairs that can be used to help applications identify and look up the context type they receive in their own domain. The idea behind this design is that applications can provide as many equivalent identifiers to a target application as possible, e.g. an instrument may be represented by an ISIN, CUSIP or Bloomberg identifier.
5958

6059
Identifiers do not make sense for all types of data, so the `id` property is therefore optional, but some derived types may choose to require at least one identifier.
6160

61+
Identifier values SHOULD always be of type string.
62+
6263
## See Also
6364

6465
FDC3 Specifications

docs/context/spec.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,8 @@ An `id` field with type `object` is defined in the base [fdc3.context](ref/Conte
110110

111111
Where an identifier is the name of an existing standard, external to FDC3, it is represented in all caps. For example: FIGI, PERMID, CUSIP, ISO-2. When an identifier is a more general concept, it is represented in all lower case. For example: ticker, name, geocode, email.
112112

113+
Identifier values SHOULD always be of type string.
114+
113115
All standard identifier names are reserved names. Applications may use their own identifiers ad hoc. For example:
114116

115117
```json

docs/trademarks.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@ Trademarks used within this site and the FDC3 Standard include, but are not limi
1212
- Eikon is a registered trademark of Refinitiv
1313
- FDC3 is a registered trademark and brand of The Linux Foundation
1414
- Excel is a Microsoft Corporation product name
15-
- Finsemble is a registered trademark and product name of Finsemble, Inc.
16-
- Glue42 is a trademark of Tick42
15+
- Finsemble is a registered trademark and product name of interop.io, Inc.
16+
- Glue42 is a trademark and product name of interop.io, Inc.
17+
- io.Connect is a trademark and product name of interop.io, Inc.
1718
- Java is a registered trademark of Oracle America, Inc.
1819
- JavaScript is a registered trademark of Oracle America, Inc.
1920
- .NET is a trademark of Microsoft Corporation

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@finos/fdc3",
3-
"version": "2.1.0-beta.5",
3+
"version": "2.1.0-beta.6",
44
"author": "Fintech Open Source Foundation (FINOS)",
55
"homepage": "https://fdc3.finos.org",
66
"repository": {

schemas/bridging/findIntentAgentRequest.schema.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@
3232
"context": {
3333
"title": "Context argument",
3434
"$ref": "../context/context.schema.json"
35+
},
36+
"resultType": {
37+
"title": "Result type argument",
38+
"type": "string"
3539
}
3640
},
3741
"required": ["intent"],

0 commit comments

Comments
 (0)