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.

Sign up for GitHub

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

Jump to bottom

Clarify document while poc fdc3 #1314

Merged
merged 5 commits into from
Sep 13, 2024
Merged

Clarify document while poc fdc3 #1314

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
065a656
update privatechannel sample code, 1, make client-side and sever-sid…
YaoYao-dd Jul 21, 2024
e03de9e
update privatechannel sample code,include the old version doc
YaoYao-dd Jul 25, 2024
86aeb52
update privatechannel sample code,update the changelog
YaoYao-dd Aug 26, 2024
71cd5df
Merge branch 'main' into clarify-document-while-poc-fdc3
YaoYao-dd Aug 26, 2024
164762b
fixed the wrong code example in DesktopAgeng.md too, update changelog
YaoYao-dd Sep 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
* Added missing `desktopAgent` field to ImplementationMetadata objects returned for all agents connect to a DesktopAgent bridge in Connection Step 6 connectAgentsUpdate messages and refined the schema used to collect this info in step 3 handshake. ([#1177](https://github.com/finos/FDC3/pull/1177))
* Removed the `version` field from `IntentResolution` as there are no version fields for intents in the FDC3 API definitions and hence the field has no purpose. ([#1170](https://github.com/finos/FDC3/pull/1170))

* Fixed an error in the Client-side example from `PrivateChannel` document as 'symbol' is misused, 'ticker' should be used to align with sever-side example, also align with instrument type standard. ([#1314](https://github.com/finos/FDC3/pull/1314))
Copy link
Contributor

@kriswest kriswest Sep 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps shorten the changelog and correct grammar:

* Fixed an error in the Client-side example from `PrivateChannel` by correcting `id.symbol` to `id.ticker` to align with the `fdc3.instrument` context. ([#1314](https://github.com/finos/FDC3/pull/1314))`

Copy link
Contributor

@kriswest kriswest Sep 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If addIntentListener example is fixed, could change to:

* Fixed error in the Client-side example from `PrivateChannel` and `addIntentListener` by correcting `id.symbol` to `id.ticker` to align with the `fdc3.instrument` context. ([#1314](https://github.com/finos/FDC3/pull/1314))

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure do, thanks.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done， can you please review, thanks.


## [npm v2.1.1] - 2024-06-28

### Fixed
Expand Down
2 changes: 1 addition & 1 deletion docs/api/ref/PrivateChannel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Although this interaction occurs entirely in frontend code, we refer to it as th

```javascript
try {
const resolution3 = await fdc3.raiseIntent("QuoteStream", { type: "fdc3.instrument", id : { symbol: "AAPL" } });
const resolution3 = await fdc3.raiseIntent("QuoteStream", { type: "fdc3.instrument", id : { ticker: "AAPL" } });
try {
const result = await resolution3.getResult();
//check that we got a result and that it's a channel
Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-2.0/api/ref/PrivateChannel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Although this interaction occurs entirely in frontend code, we refer to it as th

```javascript
try {
const resolution3 = await fdc3.raiseIntent("QuoteStream", { type: "fdc3.instrument", id : { symbol: "AAPL" } });
const resolution3 = await fdc3.raiseIntent("QuoteStream", { type: "fdc3.instrument", id : { ticker: "AAPL" } });
try {
const result = await resolution3.getResult();
//check that we got a result and that it's a channel
Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-2.1/api/ref/PrivateChannel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Although this interaction occurs entirely in frontend code, we refer to it as th

```javascript
try {
const resolution3 = await fdc3.raiseIntent("QuoteStream", { type: "fdc3.instrument", id : { symbol: "AAPL" } });
const resolution3 = await fdc3.raiseIntent("QuoteStream", { type: "fdc3.instrument", id : { ticker: "AAPL" } });
try {
const result = await resolution3.getResult();
//check that we got a result and that it's a channel
Expand Down