commit afb5d41

Merge: 523f56c b893a81 Author: Martin <github@diemattels.at> Date: Wed May 18 15:52:34 2022 +0200 Merge pull request #3816 from owncloud/doc-client-protocol [docs-only] add client protocol overview
owncloud · May 18, 2022 · 877070c · 877070c
1 parent 8236f43
commit 877070c
Show file tree

Hide file tree

Showing 9 changed files with 48 additions and 8 deletions.
diff --git a/architecture/protocol-changes.md b/architecture/protocol-changes.md
@@ -0,0 +1,40 @@
+---
+title: "Protocol changes"
+date: 2022-05-17T08:46:00+01:00
+weight: 30
+geekdocRepo: https://github.com/owncloud/ocis
+geekdocEditPath: edit/master/docs/architecture
+geekdocFilePath: protocol-changes.md
+---
+
+The spaces concept allows clients to look up the space endpoints a user has access to and then do individual sync discoveries. Technically, we introduce an indirection that allows clients to rely on server provided URLs instead of hardcoded `/webdav` or `/dav/files/{username}` paths, that may change over time.
+
+## Space discovery
+
+{{<mermaid class="text-center">}}
+%%{init: {"sequence": { "showSequenceNumbers":true, "messageFontFamily":"courier", "messageFontWeight":"normal", "messageFontSize":"11"}}}%%
+%% font weight is a css bug: https://github.com/mermaid-js/mermaid/issues/1976
+%% edit this diagram by pasting it into eg. https://mermaid.live
+sequenceDiagram
+    participant Client
+    participant Graph
+    participant SpaceA
+    participant SpaceB
+    links Client: {"web": "https://owncloud.dev/clients/web/", "RClone": "https://owncloud.dev/clients/rclone/"}
+    link Graph: Documentation @ https://owncloud.dev/extensions/graph/
+
+    Note left of Client:  First, a clients looks<br/>up the spaces a user has access to
+    opt space lookup
+        Client->>+Graph: GET /me/drives
+        Graph-->>-Client: 200 OK JSON list of spaces, say A, B and C,<br/> each with a dedicated webDavURL, etag and quota
+    end
+
+    Note left of Client: Then it can do a parallel<br/>sync discovery on spaces<br/>whose etag changed
+    par Client to Space A
+        Client->>+SpaceA: PROPFIND {webDavURL for Space A}
+        SpaceA-->>-Client: 207 Multistatus PROPFIND response
+    and Client to Space B
+        Client->>+SpaceB: PROPFIND {webDavURL for space B}
+        SpaceB-->>-Client: 207 Multistatus PROPFIND response
+    end  
+{{</mermaid>}}
diff --git a/grpc_apis/ocis/messages/search/v0/grpc.md b/grpc_apis/ocis/messages/search/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.messages.search.v0"
 url: /grpc_apis/ocis_messages_search_v0
-date: 2022-05-18T13:52:58Z
+date: 2022-05-18T13:56:12Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/messages/settings/v0/grpc.md b/grpc_apis/ocis/messages/settings/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.messages.settings.v0"
 url: /grpc_apis/ocis_messages_settings_v0
-date: 2022-05-18T13:52:58Z
+date: 2022-05-18T13:56:12Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/messages/store/v0/grpc.md b/grpc_apis/ocis/messages/store/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.messages.store.v0"
 url: /grpc_apis/ocis_messages_store_v0
-date: 2022-05-18T13:52:58Z
+date: 2022-05-18T13:56:12Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/messages/thumbnails/v0/grpc.md b/grpc_apis/ocis/messages/thumbnails/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.messages.thumbnails.v0"
 url: /grpc_apis/ocis_messages_thumbnails_v0
-date: 2022-05-18T13:52:58Z
+date: 2022-05-18T13:56:12Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/services/search/v0/grpc.md b/grpc_apis/ocis/services/search/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.services.search.v0"
 url: /grpc_apis/ocis_services_search_v0
-date: 2022-05-18T13:52:58Z
+date: 2022-05-18T13:56:12Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/services/settings/v0/grpc.md b/grpc_apis/ocis/services/settings/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.services.settings.v0"
 url: /grpc_apis/ocis_services_settings_v0
-date: 2022-05-18T13:52:58Z
+date: 2022-05-18T13:56:12Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/services/store/v0/grpc.md b/grpc_apis/ocis/services/store/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.services.store.v0"
 url: /grpc_apis/ocis_services_store_v0
-date: 2022-05-18T13:52:58Z
+date: 2022-05-18T13:56:12Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/services/thumbnails/v0/grpc.md b/grpc_apis/ocis/services/thumbnails/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.services.thumbnails.v0"
 url: /grpc_apis/ocis_services_thumbnails_v0
-date: 2022-05-18T13:52:58Z
+date: 2022-05-18T13:56:12Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---