[docs-only] add client protocol overview #3816
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes. |
|
Can you add "somewhere" a remark with a link to |
butonic
changed the title
Signed-off-by: Jörn Friedrich Dreyer <jfd@butonic.de>
butonic
force-pushed
the
doc-client-protocol
branch
from
dd4e504
to
b893a81
Compare
|
Just for the record, mermaid.live has a bug when creating an svg image which I identified when working on the admin docs. I filed an issue there, see: mermaid-js/mermaid-live-editor#796 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@dragotin @mmattel I wanted to get this off my uncommited doc / diagram list. Might be worth a blog post to go into the detail of what clients can expect and what the payload of these requests and responses looks like.
The proxy is left out as it only forwards requests to specific storage providers. We could use example urls with different hosts to indicate that the spaces can be located on different hosts.
I would like to add a sequence diagram for what happens on the server side as well, but this should be a starting point for client developers ... hm we coulvd add examples below it ... and link to https://owncloud.dev/libre-graph-api/#/me.drives/ListMyDrives