Skip to content

Commit

Permalink
Merge pull request #1312 from fidelity-contributions/Broken-link-in-h…
Browse files Browse the repository at this point in the history
…ttps/fdc3.finos.org/docs/next/api/spec

fix Broken-link-in-https/fdc3.finos.org/docs/next/api/spec
  • Loading branch information
kriswest authored Sep 13, 2024
2 parents bb22382 + 9f702b3 commit 6018f81
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/api/spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Other interfaces defined in the spec are not critical to define as concrete type

FDC3 and the Desktop Agent API it defines are intended to be independent of particular programming languages and platforms and hence the original definitions, produced in TypeScript, may be translated into other languages. However, this also places limitations on the API definitions as they need to be widely implementable in other languages.

Specifically, the use of ['unions'](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) of primitive values in API type and metadata objects, or function parameters SHOULD be avoided as they often cannot be replicated in other languages. Unions of more complex types (such as specific [Context](ref/Context) Types) may be used where a suitable interface is available or can be created to allow the required polymorphism in languages other than TypeScript.
Specifically, the use of ['unions'](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) of primitive values in API type and metadata objects, or function parameters SHOULD be avoided as they often cannot be replicated in other languages. Unions of more complex types (such as specific [Context](../context/spec#the-context-interface) Types) may be used where a suitable interface is available or can be created to allow the required polymorphism in languages other than TypeScript.

For implementation details relating to particular languages, and how to access the API in those languages, please see [Supported Platforms](supported-platforms).

Expand Down

0 comments on commit 6018f81

Please sign in to comment.