592 771 context proposal TransactionResult #761

milindchidrawar · 2022-06-22T14:01:04Z

Suggested implementation of transaction result as proposed in context data intents working group #742

netlify · 2022-06-22T14:01:21Z

✅ Deploy Preview for lambent-kulfi-cf51a7 ready!

Name	Link
🔨 Latest commit	`9d8d14a`
🔍 Latest deploy log	https://app.netlify.com/sites/lambent-kulfi-cf51a7/deploys/637c74ce003348000937e80a
😎 Deploy Preview	https://deploy-preview-761--lambent-kulfi-cf51a7.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

kriswest

This is a great start. It'll need some additional documentation under both the Intents and Context overviews and a reference from the API overview I think.

I look forward to discussing it at the next meeting

src/context/ContextType.ts

kriswest · 2022-07-01T10:57:48Z

src/intents/Intents.ts

@@ -13,4 +13,5 @@ export enum Intents {
  ViewProfile = 'ViewProfile',
  ViewQuote = 'ViewQuote',
  ViewResearch = 'ViewResearch',
+  CreateInteraction = 'CreateInteraction',


Please add in alphabetical order

kriswest · 2022-07-01T11:01:42Z

src/context/schemas/transactionresult.schema.json

+      "anyOf": [
+        {
+          "type": "string",
+          "enum": ["Created", "Deleted", "Updated"]


I think this needs to include error statuses - unless we decide that the raised intent itself should return an error.

I think we should aim to define the statuses, rather than allow any string (as the anyOf is currently allowing).

I would also suggest adding a string message field - particularly for error statuses.

Hi @kriswest. Thanks for the feedback

I see where you're coming from but I'm not sure how best to update the json. Would this do the trick?

{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://fdc3.finos.org/schemas/next/transactionresult.schema.json", "type": "object", "title": "TransactionResult", "allOf": [{ "$ref": "context.schema.json#" }], "properties": { "type": { "const": "fdc3.transactionResult" }, "status": { "type": "string", "enum": ["Created", "Deleted", "Updated", "Failed"] }, "context": { "$ref": "context.schema.json#" } }, "message": { "type": "string" }, "required": ["status", "context"] }

Yes, LGTM, although context could be optional I suppose... I guess the question is: do we want to force something to be returned?

I'm also wondering about the name of that field. Perhaps it should more strongly imply a particular use (e.g. result or output). Just a thought at this stage.

I think we probably do want something to come back. If they really don't want to return something I suppose they can put fdc3.nothing in ;-)

kriswest · 2022-07-01T11:10:53Z

docs/context/ref/TransactionResult.md

+|-------------|---------|----------|-------------------|
+| `type`      | string  | Yes      | `'fdc3.transactionResult'`  |
+| `status`      | string  | Yes       | `'Updated'`      |
+| `context`  | string  | Yes       | See Below |


Type should be Context, which will allow any other FDC3 context to be wrapped

This has been updated now

Not seeing the change... however the type filed is now Context... will add a suggestion to correct both

src/context/ContextTypes.ts

src/context/schemas/transactionresult.schema.json

kriswest · 2022-07-01T11:12:13Z

docs/context/ref/TransactionResult.md

+---
+# `TransactionResult`
+
+The result of any given create, update or delete intent.


Lets discuss this description (and other docs required) at next meeting

Neither @pauldyson or I are available to join tomorrow's context and intents discussion meeting I'm afraid.

I'm out on annual leave from tomorrow but if you could share your feedback on the description, I will take a look on my return (22nd July). Thanks

mistryvinay · 2022-07-04T17:52:06Z

Hi @milindchidrawar forgot to mention congrats on your first PR to FDC3!

So we can track this PR correctly, could we open a related issue that includes the following:

Explanation of the use case/ problem solved by this PR
Documentation in both the Context and Intent parts of the Standard describing how to use it

I'm including the issue raised by @pauldyson CreateInteraction proposal as a reference if it helps #592

milindchidrawar · 2022-07-06T12:47:28Z

Hi @kriswest @mistryvinay many thanks for the feedback. This is very helpful

I've just added another commit that should hopefully address the points you've raised. I have left a few questions in response to your feedback and would appreciate your thoughts.

@pauldyson and I are unable to attend the next two context and intents meetings, assuming the next one is two weeks today. I will review your feedback when I return on 22nd July.

Thanks

Milind.

kriswest · 2022-07-21T16:31:10Z

PR is based off of #747 and should not be merged until that has been, unless it is rebased on master first.

kriswest · 2022-07-21T16:40:02Z

docs/context/ref/TransactionResult.md

+---
+# `TransactionResult`
+
+The result of any given create, update or delete intent.


Heres a start on a deeper description. We'll also need to add something to the Intents overview doc describing the same. I'd suggest adding a new section at the bottom of https://fdc3.finos.org/docs/next/intents/spec for now, called something like:

Returning a status For transactional Intents

Suggested change

The result of any given create, update or delete intent.

`TransactionResult` is intended to be returned as an [`IntentResult`](../../api/Types#intentresult) by intents that create, retrieve, update or delete content or records in another application. Its purpose is to provide a status and message (where needed) for the transaction and MAY wrap a returned context object.

kriswest · 2022-07-21T16:42:11Z

docs/context/ref/TransactionResult.md

+| `type`      | Context  | Yes      | See Below  |
+| `status`      | string  | Yes       | `'Updated'`      |
+| `context`  | string  | Yes       | See Below |


kriswest · 2022-07-21T16:45:06Z

docs/context/spec.md

+- [`fdc3.interaction`](ref/Interaction) ([schema](/schemas/next/interaction.schema.json))
 - [`fdc3.instrument`](ref/Instrument) ([schema](/schemas/next/instrument.schema.json))
 - [`fdc3.instrumentList`](ref/InstrumentList) ([schema](/schemas/next/instrumentList.schema.json))


pls move after the fdc3.instrument* types

Suggested change

- [`fdc3.interaction`](ref/Interaction) ([schema](/schemas/next/interaction.schema.json))

- [`fdc3.instrument`](ref/Instrument) ([schema](/schemas/next/instrument.schema.json))

- [`fdc3.instrumentList`](ref/InstrumentList) ([schema](/schemas/next/instrumentList.schema.json))

- [`fdc3.instrument`](ref/Instrument) ([schema](/schemas/next/instrument.schema.json))

- [`fdc3.instrumentList`](ref/InstrumentList) ([schema](/schemas/next/instrumentList.schema.json))

- [`fdc3.interaction`](ref/Interaction) ([schema](/schemas/next/interaction.schema.json))

or rather do so in PR #747 - added suggestion there

kriswest · 2022-07-21T16:51:35Z

src/context/schemas.json

+  "Interaction": ["https://fdc3.finos.org/schemas/next/interaction.schema.json"],
  "Instrument": ["https://fdc3.finos.org/schemas/next/instrument.schema.json"],
  "InstrumentList": ["https://fdc3.finos.org/schemas/next/instrumentList.schema.json"],


Suggested change

"Interaction": ["https://fdc3.finos.org/schemas/next/interaction.schema.json"],

"Instrument": ["https://fdc3.finos.org/schemas/next/instrument.schema.json"],

"InstrumentList": ["https://fdc3.finos.org/schemas/next/instrumentList.schema.json"],

"Instrument": ["https://fdc3.finos.org/schemas/next/instrument.schema.json"],

"InstrumentList": ["https://fdc3.finos.org/schemas/next/instrumentList.schema.json"],

"Interaction": ["https://fdc3.finos.org/schemas/next/interaction.schema.json"],

kriswest · 2022-07-21T16:52:13Z

src/intents/standard intents.json

+    },
+    {
+      "name": "CreateInteraction",
+      "displayName": "Create Interaction"


Alphabetical order pls - also added to #747

kriswest · 2022-07-21T16:52:24Z

website/sidebars.json

@@ -52,6 +52,7 @@
          "intents/ref/ViewProfile",
          "intents/ref/ViewQuote",
          "intents/ref/ViewResearch",
+          "intents/ref/CreateInteraction",


Alphabetical order pls - also added to #747

kriswest · 2022-07-21T16:52:36Z

website/sidebars.json

@@ -69,13 +70,15 @@
          "context/ref/Country",
          "context/ref/Currency",
          "context/ref/Email",
+          "context/ref/Interaction",


Alphabetical order pls - also added to #747

…on-result

kriswest · 2022-11-03T11:22:39Z

CHANGELOG.md

@@ -7,6 +7,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ## [Unreleased]

 ### Added
+* Added `CreateInteraction` intent. To be used when a user wants to record an interaction into a system.  New context `Interaction` also introduced. An interaction might be a call, IM, email, a meeting (physical or virtual) or the preparation of some specialist data. ([#747](https://github.com/finos/FDC3/pull/747))


Need a change log specific to this PR - this relates to #747 ...

kriswest

A few corrections to make (mostly with suggestions you can just commit). As some are from #747 I would apply them there then merge into this PR branch and take care of the remaining items. In particular, this PR needs its own changelog entry.

Otherwise its just about there.

docs/intents/ref/CreateInteraction.md

docs/context/ref/Interaction.md

docs/intents/ref/CreateInteraction.md

src/context/schemas/interaction.schema.json

kriswest · 2022-11-03T11:37:09Z

website/yarn.lock

@@ -4,34 +4,41 @@

 "@ampproject/remapping@^2.1.0":
  version "2.2.0"
-  resolved "https://registry.yarnpkg.com/@ampproject/remapping/-/remapping-2.2.0.tgz#56c133824780de3174aed5ab6834f3026790154d"
+  resolved "https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.2.0.tgz"


Probably best to remove the lockfile from the PR....

Co-authored-by: Kris West <kris@cosaic.io>

…on-result

…ock file from PR

mistryvinay

LGTM

kriswest

Should be fine after consolidation with the CreateInteraction PR

milindchidrawar and others added 8 commits June 7, 2022 15:13

add-create-interaction-intent

9f6294f

add-create-interaction-intent

6accbc1

add-create-interaction-intent

10f1e44

Interaction context added

d74f407

update CreateInteraction to use origin instead of source

6abb14d

partial implementation of transaction results

1c37ad0

Example code for TransactionResult

2213c26

complete implementation of transaction result

c05af21

mistryvinay added enhancement New feature or request Context Data & Intents Contexts & Intents Discussion Group labels Jul 1, 2022

kriswest reviewed Jul 1, 2022

View reviewed changes

mistryvinay mentioned this pull request Jul 4, 2022

Context Data & Intents Discussion group - 7 July 2022 #769

Closed

11 tasks

mistryvinay linked an issue Jul 6, 2022 that may be closed by this pull request

Context Proposal: TransactionResult #771

Closed

update transaction result based on feedback

c1a30b8

kriswest changed the title ~~592 intent proposal create transaction result~~ 592 771 context proposal TransactionResult Jul 6, 2022

kriswest reviewed Jul 21, 2022

View reviewed changes

kriswest mentioned this pull request Jul 21, 2022

592 intent proposal create interaction #747

Merged

mistryvinay mentioned this pull request Aug 2, 2022

Context Data & Intents Discussion group - 4 Aug 2022 #791

Closed

14 tasks

milindchidrawar added 2 commits August 3, 2022 18:59

resolve alphabetical sorting for create interaction

003fb7d

updated transactionresult schema and context description

0db3dfa

milindchidrawar and others added 2 commits October 27, 2022 08:06

Merge branch 'finos:master' into 592-intent-proposal-create-transacti…

ff18e75

…on-result

include an example transactionresult for create interaction with an id

849d350

mistryvinay mentioned this pull request Oct 31, 2022

Context Data & Intents Discussion group - 3 Nov 2022 #845

Closed

12 tasks

milindchidrawar and others added 3 commits November 1, 2022 13:25

Merge branch 'finos:master' into 592-intent-proposal-create-transacti…

d77fc27

…on-result

support new id types for interaction

2799e39

full upper case for sourced id types

f1aec8a

kriswest reviewed Nov 3, 2022

View reviewed changes

kriswest requested changes Nov 3, 2022

View reviewed changes

milindchidrawar and others added 9 commits November 22, 2022 06:44

Update docs/intents/ref/CreateInteraction.md

70e83a8

Co-authored-by: Kris West <kris@cosaic.io>

Update docs/context/ref/Interaction.md

0b898eb

Co-authored-by: Kris West <kris@cosaic.io>

Update docs/context/ref/Interaction.md

2054efb

Co-authored-by: Kris West <kris@cosaic.io>

Update docs/intents/ref/CreateInteraction.md

2b27c99

Co-authored-by: Kris West <kris@cosaic.io>

Update docs/context/ref/Interaction.md

5a2246c

Co-authored-by: Kris West <kris@cosaic.io>

Update docs/intents/ref/CreateInteraction.md

a7a0631

Co-authored-by: Kris West <kris@cosaic.io>

Update src/context/schemas/interaction.schema.json

c43c6a0

Co-authored-by: Kris West <kris@cosaic.io>

Merge branch 'finos:master' into 592-intent-proposal-create-transacti…

f34e5fa

…on-result

added change log item and updated incorrect contacts label. removed l…

9d8d14a

…ock file from PR

mistryvinay mentioned this pull request Nov 30, 2022

Context Data & Intents Discussion group - 1 Dec 2022 #868

Closed

9 tasks

mistryvinay approved these changes Jan 3, 2023

View reviewed changes

mistryvinay requested a review from kriswest January 3, 2023 12:25

mistryvinay mentioned this pull request Jan 3, 2023

Context Data & Intents Discussion group - 5 Jan 2023 #888

Closed

8 tasks

mistryvinay mentioned this pull request Jan 31, 2023

Context Data & Intents Discussion group - 2 Feb 2023 #903

Closed

8 tasks

kriswest approved these changes Feb 2, 2023

View reviewed changes

mistryvinay mentioned this pull request Feb 27, 2023

Context Data & Intents Discussion group - 2 Mar 2023 #916

Closed

15 tasks

mistryvinay changed the base branch from master to context-data-and-intents-consolidated-update-branch-2.1 March 22, 2023 13:18

mistryvinay merged commit 805d4b2 into finos:context-data-and-intents-consolidated-update-branch-2.1 Mar 22, 2023

kriswest modified the milestones: 2.1-candidates, 2.1 Apr 27, 2023

kriswest removed this from the 2.1 milestone Jul 25, 2023

bingenito mentioned this pull request Nov 6, 2023

Update to FDC3 2.1 finos/fdc3-dotnet#74

Closed

18 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

592 771 context proposal TransactionResult #761

592 771 context proposal TransactionResult #761

milindchidrawar commented Jun 22, 2022

netlify bot commented Jun 22, 2022 •

edited

Loading

kriswest left a comment •

edited

Loading

kriswest Jul 1, 2022

milindchidrawar Jul 6, 2022

kriswest Jul 1, 2022

milindchidrawar Jul 6, 2022 •

edited

Loading

kriswest Jul 21, 2022

kriswest Jul 21, 2022

kriswest Jul 1, 2022

milindchidrawar Jul 6, 2022

kriswest Jul 21, 2022

kriswest Jul 1, 2022

milindchidrawar Jul 6, 2022

mistryvinay commented Jul 4, 2022 •

edited

Loading

milindchidrawar commented Jul 6, 2022

kriswest commented Jul 21, 2022

kriswest Jul 21, 2022

kriswest Jul 21, 2022 •

edited

Loading

kriswest Jul 21, 2022

kriswest Jul 21, 2022

kriswest Jul 21, 2022

kriswest Jul 21, 2022

kriswest Jul 21, 2022

kriswest Jul 21, 2022

kriswest Nov 3, 2022

kriswest left a comment

kriswest Nov 3, 2022

mistryvinay left a comment

kriswest left a comment

	The result of any given create, update or delete intent.
	`TransactionResult` is intended to be returned as an [`IntentResult`](../../api/Types#intentresult) by intents that create, retrieve, update or delete content or records in another application. Its purpose is to provide a status and message (where needed) for the transaction and MAY wrap a returned context object.

592 771 context proposal TransactionResult #761

592 771 context proposal TransactionResult #761

Conversation

milindchidrawar commented Jun 22, 2022

netlify bot commented Jun 22, 2022 • edited Loading

✅ Deploy Preview for lambent-kulfi-cf51a7 ready!

kriswest left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

milindchidrawar Jul 6, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mistryvinay commented Jul 4, 2022 • edited Loading

milindchidrawar commented Jul 6, 2022

kriswest commented Jul 21, 2022

Choose a reason for hiding this comment

kriswest Jul 21, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kriswest left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mistryvinay left a comment

Choose a reason for hiding this comment

kriswest left a comment

Choose a reason for hiding this comment

netlify bot commented Jun 22, 2022 •

edited

Loading

kriswest left a comment •

edited

Loading

milindchidrawar Jul 6, 2022 •

edited

Loading

mistryvinay commented Jul 4, 2022 •

edited

Loading

kriswest Jul 21, 2022 •

edited

Loading