diff --git a/services/graph/README.md b/services/graph/README.md index 4a1b8d567..98fd6a221 100644 --- a/services/graph/README.md +++ b/services/graph/README.md @@ -1,3 +1,15 @@ # Graph service The graph service provides the Graph API which is a RESTful web API used to access Infinite Scale resources. It is inspired by the [Microsoft Graph API](https://learn.microsoft.com/en-us/graph/use-the-api) and can be used by clients or other services or extensions. + +## Manual Filters + +Using the API, you can manually filter like for users. See the [Libre Graph API](https://owncloud.dev/libre-graph-api/#/users/ListUsers) for examples in the [developer documentation](https://owncloud.dev). Note that you can use `and` to refine results. + +## Sequence Diagram + +The following image gives an overview of the scenario when a client requests to list available spaces the user has access to. To do so, the client is directed with his request automatically via the proxy service to the graph service. + + + + diff --git a/services/graph/images/mermaid-graph.svg b/services/graph/images/mermaid-graph.svg new file mode 100644 index 000000000..6ff62a89f --- /dev/null +++ b/services/graph/images/mermaid-graph.svg @@ -0,0 +1 @@ +ClientGraphSpaceASpaceBFirst, a clients looksup the spaces a user has access toopt[space lookup]Then it can do a parallelsync discovery on spaceswhose etag changedpar[Client to Space A][Client to Space B]GET /me/drives200 OK JSON list of spaces, say A, B and C, each with a dedicated webDavURL, etag and quotaPROPFIND {webDavURL for Space A}207 Multistatus PROPFIND responsePROPFIND {webDavURL for space B}207 Multistatus PROPFIND responseClientGraphSpaceASpaceBwebRCloneDocumentation