search

finos / FDC3

An open standard for the financial desktop.
https://fdc3.finos.org
Other
193 stars 115 forks source link

Client-side example mistakenly refer to wrong name "symbol" in PrivateChannel doc #1279

Open YaoYao-dd opened 1 month ago

YaoYao-dd commented 1 month ago

Minor Issue

Client-side example mistakenly refer to wrong name "symbol" in PrivateChannel doc， it should be 'ticker' like below.

const resolution3 = await fdc3.raiseIntent("QuoteStream", { type: "fdc3.instrument", id : { **ticker**: "AAPL" } });
    try {

for below reasons:

  1. make client-side and sever-side be consistent, both use 'ticker',
  2. content data standard also defines instrument type with 'ticker'.

Area of Issue

[ ] App Directory [*] API [ ] Context Data [ ] Intents [ ] Desktop Agent Bridging [ ] Use Cases [ ] Other

YaoYao-dd commented 1 month ago

I can open PR to fix this if necessary, thanks.

kriswest commented 1 month ago

You are correct, there is an error here: https://github.com/finos/FDC3/blob/aaa2a803069649180751964b7e0f210dbd48b1f3/docs/api/ref/PrivateChannel.md?plain=1#L80

When raising a PR to fix this, it should also be fixed in past versions:

And a Changelog entry in the FIxed section would also be appreciated: https://github.com/finos/FDC3/blob/main/CHANGELOG.md

bingenito commented 1 month ago

I verified the pending .NET sample in #1108 has Ticker as the ID property

YaoYao-dd commented 1 month ago

will raise PR, thanks @kriswest

YaoYao-dd commented 2 weeks ago

PR opened, https://github.com/finos/FDC3/pull/1314, thanks