Skip to content

Commit fabbb0b

Browse files
committed
Added missing section about Share Creation Response and removed duplicated text
1 parent 2a934e8 commit fabbb0b

File tree

1 file changed

+24
-13
lines changed

1 file changed

+24
-13
lines changed

IETF-RFC.md

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ thing. This is achieved by providing a protocol that abstracts away
7474
security and authentication details from the users to the servers acting
7575
on behalf of the users. Another important point of the protocol is the
7676
invitation mechanism that lets users connect over established human
77-
relationships and uses those connections to establish contact between
77+
relationships and use those connections to establish contact between
7878
their respective OCM servers.
7979

8080
# Terms
@@ -849,6 +849,27 @@ To create a Share, the Sending Server SHOULD make a HTTP POST request
849849
An optional secret to be used to access the remote
850850
web app, for example in the form of a bearer token.
851851

852+
## Response
853+
854+
The Share Creation Notification Response SHOULD be a HTTP response:
855+
856+
* in response to the Share Creation Notification Request
857+
* using `application/json` as the `Content-Type` HTTP response header
858+
859+
A 201 response status means the Share Creation Notification Request was
860+
successful. In this case, the response body MUST contain a JSON
861+
document representing an object with the following string fields:
862+
- REQUIRED: `recipientDisplayName` - the Recipient's display name.
863+
A 400 response status means some parameters were invalid or missing.
864+
A 401 response status means the Sender cannot be authenticated as
865+
a trusted service.
866+
A 403 response status means the Sender is not authorized to create
867+
shares.
868+
A 501 response status means either the Receiver does not support
869+
incoming external shares, or the share type or the resource type
870+
are not supported.
871+
A 503 response status means that the Receiver is temporary unavailable.
872+
852873
## Decision to Discard
853874

854875
The Receiving Server MAY discard the notification if any of the
@@ -874,7 +895,7 @@ following hold true:
874895
* an initial check shows that the Resource cannot successfully be
875896
accessed through (any of) the protocol(s) listed
876897

877-
# Receiving Party Notification
898+
## Receiving Party Notification
878899

879900
If the Share Creation Notification is not discarded by the Receiving
880901
Server, they MAY notify the Receiving Party passively by adding the
@@ -885,6 +906,7 @@ They could give the Receiving Party the option to accept or reject the
885906
share, or add the share automatically and only send an informational
886907
notification that this happened.
887908

909+
888910
# Share Acceptance Notification
889911

890912
In response to a Share Creation Notification, the Receiving Server MAY
@@ -931,17 +953,6 @@ of the notification. Receiving Servers SHOULD decline notifications
931953
from Sending Servers without httpsig as it can't identify where the
932954
notification is coming from.
933955

934-
### Receiving Party Notification
935-
936-
If the Share Creation Notification is not discarded by the Receiving
937-
Server, they MAY notify the Receiving Party passively by adding the
938-
Share to some inbox list, and MAY also notify them actively through for
939-
instance a push notification or an email message.
940-
941-
They could give the Receiving Party the option to accept or reject the
942-
Share, or add the Share automatically and only send an informational
943-
notification that this happened.
944-
945956
# Resource Access
946957

947958
To access the Resource, the Receiving Server MAY use multiple ways,

0 commit comments

Comments
 (0)