Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
YaoYao-dd opened this issue Jul 22, 2024 · 6 comments
Labels
docs Documentation good first issue Good for newcomers needs-pr

Comments

@YaoYao-dd
Copy link
Contributor

YaoYao-dd commented Jul 22, 2024

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 YaoYao-dd added the bug Something isn't working label Jul 22, 2024
@YaoYao-dd
Copy link
Contributor Author

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

@kriswest kriswest added good first issue Good for newcomers docs Documentation needs-pr and removed bug Something isn't working labels Jul 22, 2024
@kriswest
Copy link
Contributor

You are correct, there is an error here:

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

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
Copy link
Member

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

@YaoYao-dd
Copy link
Contributor Author

will raise PR, thanks @kriswest

@YaoYao-dd
Copy link
Contributor Author

PR opened, #1314, thanks

@kriswest
Copy link
Contributor

closed as completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation good first issue Good for newcomers needs-pr
Projects
None yet
Development

No branches or pull requests

3 participants