Skip to content

Commit 411529b

Browse files
committed
Renamed USER_REMOVED to CONTACT_REMOVED and spelled out the cases
1 parent 3292518 commit 411529b

2 files changed

Lines changed: 18 additions & 12 deletions

File tree

‎IETF-OCM.md‎

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1497,26 +1497,31 @@ such as HTTP 404.
14971497
A notification MAY be sent to inform a target OCM Server that a share
14981498
recipient (e.g. a user or group) was removed from the list of trusted
14991499
users, following a previous successful Invitation, or otherwise left
1500-
the system. That recipient may have been previously known to the
1501-
target server because of existing shares whose shareType matched it.
1502-
The recipient of such notification MAY reciprocally remove that
1503-
recipient from the list of trusted users, along with any related
1504-
shares.
1500+
the realm of the sending OCM Server. That recipient may have been
1501+
previously known to the target server because of existing shares whose
1502+
shareType matched it. The recipient of such notification SHOULD
1503+
reciprocally remove that peer from the list of trusted users, along
1504+
with any related shares.
15051505

15061506
For these cases, a notification payload is to be formed such that the
15071507
`resourceType` MUST be omitted, the `shareType` is set to the affected
15081508
shareType being removed, such as `user` or `group`, and the
15091509
`notificationType` MUST be one of:
1510-
- "USER_REMOVED", to inform about a single user that was removed or
1511-
marked as not trusted.
1512-
- "GROUP_REMOVED", to inform about a removed group.
1510+
- "CONTACT_REMOVED", to inform that a single user contact was removed
1511+
from the list of trusted contacts, either by the peer user or by the
1512+
system e.g. in case that user left.
1513+
- "GROUP_REMOVED", to inform about a removed group of users.
15131514
Further, the `notification` object MUST include the following fields:
15141515
* OPTIONAL message (string) - an optional human-readable message that
15151516
describes the event.
15161517
* REQUIRED user or group (object) - an object containing the details
15171518
of the recipient to be removed. In case of `user`, it MUST include:
1518-
* REQUIRED userId (string) - OCM Address of the user to be removed
1519-
from the target OCM Server.
1519+
* REQUIRED userId (string) - OCM Address of the user that performed
1520+
the removal, or that left.
1521+
* OPTIONAL localUserId (string) - OCM Address of the user, local at
1522+
the target server, that was removed by the above peer contact.
1523+
If missing, it is assumed that the user to be removed has left the
1524+
realm of the sending OCM Server.
15201525
Whereas in case of `group`, it MUST include:
15211526
* REQUIRED groupId (string) - identifier of the group to be removed
15221527
from the target OCM Server.

‎spec.yaml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1015,14 +1015,15 @@ components:
10151015
message: Recipient accepted the share
10161016
file:
10171017
providerId: 7c084226-d9a1-11e6-bf26-cec0c932ce01
1018-
userWasRemoved:
1019-
notificationType: USER_REMOVED
1018+
contactWasRemoved:
1019+
notificationType: CONTACT_REMOVED
10201020
shareType: user
10211021
senderDomain: alice.example.org
10221022
notification:
10231023
message: User is not a trusted contact any longer
10241024
user:
10251025
userId: alice@alice.example.org
1026+
localUserId: bob@bob.example.org
10261027
mlsWelcome:
10271028
notificationType: MLS_WELCOME
10281029
shareType: federation

0 commit comments

Comments
 (0)