You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-2Lines changed: 9 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,11 +10,12 @@ the [OpenAPI](https://github.com/OAI/OpenAPI-Specification) (fka Swagger) specif
10
10
*[Discovery](#discovery)
11
11
*[Share Creation](#create)
12
12
*[Share Acceptance](#accept)
13
+
*[Share Access](#access)
13
14
*[Share Deletion](#unshare)
14
15
*[Share Updating](#update)
15
16
*[Resharing](#reshare)
16
17
*[Invite](#invite)
17
-
18
+
18
19
*[Contributing](#contributing)
19
20
20
21
## Scope and assumptions
@@ -41,6 +42,13 @@ To create a share, the sending server SHOULD make a HTTP POST request to the `/s
41
42
### Share Acceptance
42
43
In response to a share creation, the receiving server MAY send back a [notification](https://cs3org.github.io/OCM-API/docs.html?branch=develop&repo=OCM-API&user=cs3org#/paths/~1notifications/post) to the sending server, with `notificationType` set to `"SHARE_ACCEPTED"` or `"SHARE_DECLINED"`. The sending server MAY expose this information to the end user.
43
44
45
+
### Share Access
46
+
To access a share, the receiving server MAY use multiple ways, depending on the received payload and on the `protocol.name` property:
47
+
48
+
* If `protocol.name` = `multi`, the receiver SHOULD make a HTTP PROPFIND request to `protocol.webdav.uri` to access the remote resource. If `protocol.webdav.sharedSecret` is not empty, the receiver SHOULD pass it as a `Authorization: bearer` header.
49
+
50
+
* If `protocol.name` = `webdav`, the receiver SHOULD inspect the `protocol.options` property. If it contains a `sharedSecret`, as in the [legacy example](https://cs3org.github.io/OCM-API/docs.html?branch=develop&repo=OCM-API&user=cs3org#/paths/~1shares/post), then the receiver SHOULD make a HTTP PROPFIND request to `https://<token>:@<host><path>/<rel_path>`, where: `<host>` is the remote server, `<path>` is obtained by querying the [Discovery](#discovery) endpoint and extracting `resourceTypes[0].protocols.webdav`, and optionally `<rel_path>` is the relative path of the resource within the share, when needed.
51
+
44
52
### Share Deletion
45
53
A `"SHARE_ACCEPTED"` notification followed by a `"SHARE_UNSHARED"` notification is
46
54
equivalent to a `"SHARE_DECLINED"` notification.
@@ -73,7 +81,6 @@ The specification can be rendered as HTML documentation using [ReDoc](https://gi
73
81
*[version 1.0](https://cs3org.github.io/OCM-API/docs.html?branch=v1.0.0&repo=OCM-API&user=cs3org#/paths/~1shares/post), current official and supported version
74
82
*[develop branch](https://cs3org.github.io/OCM-API/docs.html?branch=develop&repo=OCM-API&user=cs3org), future version supported by ScienceMesh
75
83
76
-
77
84
The Open Cloud Mesh API specification is an open source, community-driven project. If you'd like to contribute, please follow the [Contributing Guidelines](CONTRIBUTING.md).
78
85
79
86
To stage the changes of your PR, you can change the repo and branch in the URL.
0 commit comments