[SERVICE-542] Refresh FDC3 API docs #120
[SERVICE-542] Refresh FDC3 API docs #120
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some comments to start things off.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lots of comments, but mostly wanting to squish inconsistencies in vocabulary
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved pending conflict fixing
…into tim-dinsdale-dev/tim/SERVICE-543-1
…into dev/tim/SERVICE-543-1
…le/fdc3-service into dev/tim/SERVICE-543-1
# Conflicts: # package-lock.json # src/client/context.ts # src/client/directory.ts # src/client/main.ts # src/demo/apps/ChartsApp.tsx # src/demo/apps/NewsApp.tsx # src/provider/controller/ResolverHandler.ts # src/provider/index.ts # src/provider/model/AppWindow.ts # src/provider/model/FinEnvironment.ts # test/demo/utils/fdc3RemoteExecution.ts # test/demo/utils/ofPuppeteer.ts # test/mocks.ts
… and adding details around changes since the original docs PR.
@pjbroadbent Taken another look, still outstanding comments |
…ions options as per FDC3 specs, replaced redundant Intent type with AppDirIntent.
…543-1 # Conflicts: # package-lock.json # src/client/context.ts # test/demo/raiseIntent/withoutTarget.inttest.ts # test/demo/utils/fdc3RemoteExecution.ts
…543-1 # Conflicts: # src/provider/model/AppWindow.ts # test/demo/raiseIntent/withTarget.inttest.ts # test/mocks.ts # test/provider/Model.unittest.ts
…ack'. Removed unused default intent definitions from provider. Removed duplicate Intent type definitions, added in earlier commit.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, spotted a bunch more things. Think the only ones I really care about are "it's" v. "its". Can live with the more subjective stuff being ignored
* | ||
* A context object is open for extension with any custom properties/metadata. | ||
* General-purpose context type, as defined by [FDC3](https://fdc3.finos.org/docs/1.0/context-intro). | ||
* A context object is a well-understood datum that is streamable between FDC3 participants. As a result |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is "streamable" the right term here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
serializable?..
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
shareable?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Meh
Documentation