Skip to content

Commit 892ae51

Browse files
committed
Adding an additional note in documentation that identifier values SHOULD be of type string
1 parent 1db221a commit 892ae51

2 files changed

Lines changed: 5 additions & 2 deletions

File tree

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

0 commit comments

Comments
 (0)