From 322924d1c3b5b54a4b7a9229867e41bcafde4160 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Friedrich=20Dreyer?= Date: Mon, 12 Sep 2022 20:29:04 +0000 Subject: [PATCH 1/2] update sharing docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jörn Friedrich Dreyer --- docs/services/frontend/_index.md | 21 +++++++++++++++++++++ docs/services/sharing/_index.md | 2 +- 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/docs/services/frontend/_index.md b/docs/services/frontend/_index.md index 097fde932..6d99832a9 100644 --- a/docs/services/frontend/_index.md +++ b/docs/services/frontend/_index.md @@ -10,7 +10,28 @@ geekdocCollapseSection: true ## Abstract +The frontend service provides multiple HTTP endpoints to translate OCS, archiver and approvider requests into CS3 requests. ## Table of Contents {{< toc-tree >}} + +## OCS + +The OCS endpoint implements the open collaboration services API in a backwards compatible manner. + +### Sharing + +Aggregating share information as one of the most time consuming operations in OCIS. The service fetches a list of either received or created shares and has to stat every resource individually. While stats are fast, the default behavior scales linear with the number of shares. + +To save network trips the sharing implementation can cache the stat requests with an in memory cache or in redis. It will shorten the response time by the network rountrip overhead at the cost of the API only eventually being updated. + +Setting `FRONTEND_OCS_RESOURCE_INFO_CACHE_TTL=60` would cache the stat info for 60 seconds. Increasing this value makes sense for large deployments with thousands of active users that keep the cache up to date. Low frequency usage scenarios should not expect a noticeable improvement. + +## Archiver + +The archiver endpoint provides bundled downloads of multiple files and folders. + +## Appprovider + +The appprovider endpoint is used to manage available apps that can be used to open different file types. \ No newline at end of file diff --git a/docs/services/sharing/_index.md b/docs/services/sharing/_index.md index be41c1be9..ecdc21f5f 100644 --- a/docs/services/sharing/_index.md +++ b/docs/services/sharing/_index.md @@ -9,7 +9,7 @@ geekdocCollapseSection: true ## Abstract -This service provides sharing functionality. +This service implements the CS3 [LinkAPI](https://cs3org.github.io/cs3apis/#cs3.sharing.link.v1beta1.LinkAPI) to manage public links as well as the [CollaborationAPI](https://cs3org.github.io/cs3apis/#cs3.sharing.collaboration.v1beta1.CollaborationAPI) to manage user and group shares. ## Table of Contents From 30b41dc21c75e305e319527ade0d37d9c63643b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Friedrich=20Dreyer?= Date: Wed, 14 Sep 2022 17:45:36 +0200 Subject: [PATCH 2/2] Update docs/services/frontend/_index.md Co-authored-by: Phil Davis --- docs/services/frontend/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/services/frontend/_index.md b/docs/services/frontend/_index.md index 6d99832a9..20ace43cb 100644 --- a/docs/services/frontend/_index.md +++ b/docs/services/frontend/_index.md @@ -22,7 +22,7 @@ The OCS endpoint implements the open collaboration services API in a backwards c ### Sharing -Aggregating share information as one of the most time consuming operations in OCIS. The service fetches a list of either received or created shares and has to stat every resource individually. While stats are fast, the default behavior scales linear with the number of shares. +Aggregating share information is one of the most time consuming operations in OCIS. The service fetches a list of either received or created shares and has to stat every resource individually. While stats are fast, the default behavior scales linearly with the number of shares. To save network trips the sharing implementation can cache the stat requests with an in memory cache or in redis. It will shorten the response time by the network rountrip overhead at the cost of the API only eventually being updated.