Flow documentation #164
Flow documentation #164
Conversation
| <mxPoint x="570" y="210" as="targetPoint" /> | ||
| </mxGeometry> | ||
| </mxCell> | ||
| <mxCell id="NDPqdjoCEg37fMv0_q80-18" value="<p style="margin:0px;margin-top:4px;text-align:center;text-decoration:underline;"><b>Invitation:Type</b></p><hr size="1" style="border-style:solid;"><p style="margin:0px;margin-left:8px;">Tokrn :&nbsp;<b>string</b>&nbsp;<br>email :&nbsp;<b style="background-color: initial;">string</b><span style="background-color: initial;">&nbsp;</span></p><p style="margin:0px;margin-left:8px;"><span style="background-color: initial;">accepted :&nbsp;</span><b style="background-color: initial;">bool</b><span style="background-color: initial;">&nbsp;</span><br></p><p style="margin: 0px 0px 0px 8px;">createdAt :&nbsp;<b style="background-color: initial;">datetime</b><span style="background-color: initial;">&nbsp;</span></p><p style="margin: 0px 0px 0px 8px;">expiresAt :&nbsp;<b style="background-color: initial;">?datetime</b><span style="background-color: initial;">&nbsp;</span></p><p style="margin: 0px 0px 0px 8px;">acceptedAt :&nbsp;<b style="background-color: initial;">?datetime</b><span style="background-color: initial;">&nbsp;</span></p><div><br></div>" style="verticalAlign=top;align=left;overflow=fill;html=1;whiteSpace=wrap;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1"> |
There was a problem hiding this comment.
The email should be optional in the database table, because we want our schema to support situations where invites are generated and then sent for instance via Matrix instead of via email
There was a problem hiding this comment.
Throught the I-D we use the term 'Invite' so maybe call the db table 'Invites'?
There was a problem hiding this comment.
'Reciever' -> 'Receiver'
There was a problem hiding this comment.
'submiting' -> 'submitting'
There was a problem hiding this comment.
For AcceptInvitationRequestDto, please use the field names as they actually appear in the API call (section 3.5.2. Invite Acceptance Request Details), so:
- recipientProvider
- token
- userID
- name
There was a problem hiding this comment.
Samce for Invite Acceptance Response, and maybe rename them to:
- InviteAcceptanceRequestDto
- InviteAcceptanceResponseDto
| @@ -14,6 +14,11 @@ Previous versions: | |||
|
|
|||
| [SemVer](https://semver.org) versioning applies to OCM, and all versions are supported unless stated otherwise by an implementation. | |||
|
|
|||
| ## Invitation flow at a glance | |||
There was a problem hiding this comment.
I suggest to not include this in the README, there are quite a few flows and the Invite is not even the core one, therefore it does not make much sense to show it here.
No description provided.