Invitation workflow for OCM #41

LovisaLugnegard · 2020-04-01T12:38:43Z

This PR contains an invitation workflow for OCM to discover users in remote system while preserving privacy.

ocm: enhance invitation flow

LovisaLugnegard · 2020-04-15T14:37:54Z

@ishank011 and @labkode Do you see a reason for using both "invite" and "invitation" in the API description? If we use both I think we should be clear that they either mean the same (no need to use both in that case), or what the difference is.

ishank011

Hi Lovisa. Looks good - just a couple of comments.

spec.yaml

* add more services to gateway * fix ocm * clean * add expose field to InititiateFileUpload/Download * extend download/upload responses for metadata gateway * add user provider service * fix userprovier api * fix format * fix types * fix is in logic for userprovider * add userprovider to the gatewayg * add userId to GenerateAcccessTokenResponse * add authregistry and authprovider * move user type to user manager package * fix user namespace

Add name and email to invites/accept request

pferreir · 2020-06-23T15:32:21Z

spec.yaml

+  /invites/forward:
+    post:
+      summary: Forward an invitation to start sharing
+      description: Forwards an invitation received by an out-of-band channel, email for example.


Maybe "through an out-of-band channel", or "via" would be easier to understand?

That's a nice improvement, I'll update.

michielbdejong · 2021-08-06T08:34:05Z

spec.yaml

@@ -355,6 +355,47 @@ paths:
              type: string
          schema:
            $ref: "#/definitions/Error"
+  /invites/forward:


Who forwards the invitation when this end-point is called, and from where to where?

IIUC from https://www.youtube.com/watch?v=TnlUOG3lOu4, the flow would be as follows, if Alice at server A invites Bob at server B:

Alice instructs A to send an invite to "Bob@B"

A changes state, "invite sent from Alice to Bob@B"

A calls B/invites/forward

B changes state, "invite received from Alice@A to Bob"

B notifies Bob (this is the "forwarding", right?)

Bob instructs B to accept the invitation

B changes state, "invite from Alice@A to Bob accepted"

B calls A/invites/accept

A changes state, "invite from Alice to Bob@B accepted"

If this is correct, then I think the summary and description should reflect that it is B who forwards the invite from A (or effectively from Alice@A) to Bob?

The summary "Forward an invitation to start sharing" suggests that the agent doing the forwarding (B) is also the agent who starts sharing, but I think it's more accurate to say Alice@A starts sharing.

Also, since B forwards from the inner network to the last mile end-point, "deliver" might have been a better verb than "forward".

The delivery of the notification is not the main functionality exposed by this API endpoint; rather, if and how B notifies Bob is not even the concern of A or of Alice@A. So given that there is also a state change in B, maybe "create" (as in "create an entry in your list of received invites") would have been even better than "forward" or "deliver".

The description "Forwards an invitation received through an out-of-band channel, email for example." describes how the invitation was received, but I think the intention was to describe how the invitation gets forwarded.
So maybe "Forwards a received invitation through an out-of-band channel, email for example." is clearer?

And for the summary I would suggest "Notify the recipient of a new invite"

Ah wait, I ran through https://reva.link/docs/tutorials/share-tutorial/#4-2-accept-the-token again and this actually looks like accepting the invite is not a server-to-server interaction, but a client-to-server one?
Should the OCM API not only define those, or leave that to each implementer?
In the end it doesn't matter to Alice or to A how Bob and B communicate with each other, right?

michielbdejong · 2021-10-14T11:12:03Z

What is the difference between ForwardInvite and AcceptInvite?

michielbdejong · 2021-10-21T17:15:57Z

I think we should only add /invites/accept to the OCM API, and there is no need to define an /invites/forward endpoint.

Looking at the reva code there is a ForwardInvite function which does a http call to
acceptInviteEndpoint "/invites/accept".

But the AcceptInvite function does not do any http calls (it's the function that gets called when a http request comes in over the server's OCM API.

michielbdejong · 2021-10-21T17:18:00Z

I'll see if I can create a PR to supersede this one (which is now 18 months old and hasn't been getting much movement recently).

michielbdejong · 2021-10-21T17:20:09Z

I think we should also define this end point as application/json (like the other ones), not as application/x-www-form-urlencoded which is currently the only format supported by reva.

michielbdejong · 2021-10-21T17:34:14Z

I see revad additionally has a http endpoint where an authenticated user can cause an invite to be generated and emailed out.
There also is a forwardInvite handler which takes an invite token and an origin providerDomain and converts those into a grpc request for ForwardInvite. It is unclear to me why a reva user would use this http method instead of just using the equivalent grpc method directly?

glpatcern · 2022-06-21T15:12:26Z

Superseded by #54, please let's resume the discussion there.

Add endpoints for accept and forward invite

dcdc02e

LovisaLugnegard force-pushed the add-endpoint-to-accept-invite branch from e6bc7e6 to dcdc02e Compare April 2, 2020 06:50

This was referenced Apr 2, 2020

WIP: Update swagger new endpoints for invitation discovery #39

Closed

CERN: Implement invite/forward sciencemesh/sciencemesh#35

Open

CERN: Implement invite/accept sciencemesh/sciencemesh#36

Closed

labkode changed the title ~~Add endpoint for accept invite~~ Invitation for OCM Apr 14, 2020

labkode changed the title ~~Invitation for OCM~~ Invitation workflow for OCM Apr 14, 2020

labkode and others added 5 commits April 15, 2020 09:12

ocm: enhance invitation flow

7fe8bc6

ocm: fix

634561d

fix leading slash

50540d1

Merge pull request #1 from labkode/enhance-ocm-invite

2989d9d

ocm: enhance invitation flow

Smaller copy updates

c57129b

Minor updates in the invites API

8fdc1d9

ishank011 suggested changes Apr 17, 2020

View reviewed changes

spec.yaml Outdated Show resolved Hide resolved

spec.yaml Outdated Show resolved Hide resolved

ishank011 reviewed Apr 17, 2020

View reviewed changes

spec.yaml Outdated Show resolved Hide resolved

Fix typos

a840caf

ishank011 mentioned this pull request Apr 22, 2020

Add more parameters to /invite/accept sciencemesh/sciencemesh#55

Closed

sunjam mentioned this pull request Apr 25, 2020

Does OCM-API have any roadmap or plans for future development? #43

Closed

ishank011 and others added 2 commits April 27, 2020 17:51

Add name and email to invites/accept request

98e8e4d

Merge pull request #2 from LovisaLugnegard/add_invite_accept_params

8fe2fe3

Add name and email to invites/accept request

labkode changed the title ~~Invitation workflow for OCM~~ [WIP] Invitation workflow for OCM May 11, 2020

pferreir reviewed Jun 23, 2020

View reviewed changes

Improve description

f2d17c0

labkode changed the title ~~[WIP] Invitation workflow for OCM~~ Invitation workflow for OCM Jun 15, 2021

labkode marked this pull request as ready for review June 15, 2021 21:26

michielbdejong reviewed Aug 6, 2021

View reviewed changes

glpatcern mentioned this pull request Jun 21, 2022

Invitation workflow for OCM, take 2 #54

Merged

glpatcern closed this Jun 21, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Invitation workflow for OCM #41

Invitation workflow for OCM #41

LovisaLugnegard commented Apr 1, 2020 •

edited by labkode

Loading

LovisaLugnegard commented Apr 15, 2020

ishank011 left a comment

pferreir Jun 23, 2020 •

edited

Loading

LovisaLugnegard Jun 24, 2020

michielbdejong Aug 6, 2021

michielbdejong Aug 6, 2021 •

edited

Loading

michielbdejong Aug 6, 2021 •

edited

Loading

michielbdejong Aug 6, 2021

michielbdejong Aug 11, 2021

michielbdejong commented Oct 14, 2021

michielbdejong commented Oct 21, 2021 •

edited

Loading

michielbdejong commented Oct 21, 2021

michielbdejong commented Oct 21, 2021

michielbdejong commented Oct 21, 2021

glpatcern commented Jun 21, 2022

Invitation workflow for OCM #41

Invitation workflow for OCM #41

Conversation

LovisaLugnegard commented Apr 1, 2020 • edited by labkode Loading

LovisaLugnegard commented Apr 15, 2020

ishank011 left a comment

Choose a reason for hiding this comment

pferreir Jun 23, 2020 • edited Loading

Choose a reason for hiding this comment

LovisaLugnegard Jun 24, 2020

Choose a reason for hiding this comment

michielbdejong Aug 6, 2021

Choose a reason for hiding this comment

michielbdejong Aug 6, 2021 • edited Loading

Choose a reason for hiding this comment

michielbdejong Aug 6, 2021 • edited Loading

Choose a reason for hiding this comment

michielbdejong Aug 6, 2021

Choose a reason for hiding this comment

michielbdejong Aug 11, 2021

Choose a reason for hiding this comment

michielbdejong commented Oct 14, 2021

michielbdejong commented Oct 21, 2021 • edited Loading

michielbdejong commented Oct 21, 2021

michielbdejong commented Oct 21, 2021

michielbdejong commented Oct 21, 2021

glpatcern commented Jun 21, 2022

LovisaLugnegard commented Apr 1, 2020 •

edited by labkode

Loading

pferreir Jun 23, 2020 •

edited

Loading

michielbdejong Aug 6, 2021 •

edited

Loading

michielbdejong Aug 6, 2021 •

edited

Loading

michielbdejong commented Oct 21, 2021 •

edited

Loading