Skip to content

Commit

Permalink
Adding an additional note in documentation that identifier values SHO…
Browse files Browse the repository at this point in the history
…ULD be of type string
  • Loading branch information
kriswest committed Feb 6, 2024
1 parent 1db221a commit 892ae51
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/context/ref/Context.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,12 @@ derived types may require the name object as mandatory, depending on use case.

### `id` (optional)

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.
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.

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.

Identifier values SHOULD always be of type string.

## See Also

FDC3 Specifications
Expand Down
2 changes: 2 additions & 0 deletions docs/context/spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,8 @@ An `id` field with type `object` is defined in the base [fdc3.context](ref/Conte

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.

Identifier values SHOULD always be of type string.

All standard identifier names are reserved names. Applications may use their own identifiers ad hoc. For example:

```json
Expand Down

0 comments on commit 892ae51

Please sign in to comment.