From 08ed47efcbd644765e784abe2088ec4e727e5e1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Schie=C3=9Fle?= Date: Wed, 24 Feb 2016 12:03:47 +0100 Subject: [PATCH 1/2] fix url to accept remote shares --- developer_manual/core/ocs-share-api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/developer_manual/core/ocs-share-api.rst b/developer_manual/core/ocs-share-api.rst index 01e59b5a1..7408fc01d 100644 --- a/developer_manual/core/ocs-share-api.rst +++ b/developer_manual/core/ocs-share-api.rst @@ -166,7 +166,7 @@ Accept a pending Federated Cloud Share Locally accept a received federated cloud share that was sent from a remote instance. -* Syntax: /remote_shares/** +* Syntax: /remote_shares/pending/** * Method: POST * Arguments: share_id - (int) share ID From 2a8601a29db2232fcd626e4419bd72500f650eb8 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Mon, 29 Feb 2016 10:45:46 +0100 Subject: [PATCH 2/2] Add docs about list+delete of federated shares --- developer_manual/core/ocs-share-api.rst | 57 ++++++++++++++++++++++--- 1 file changed, 52 insertions(+), 5 deletions(-) diff --git a/developer_manual/core/ocs-share-api.rst b/developer_manual/core/ocs-share-api.rst index 7408fc01d..d5dd7631f 100644 --- a/developer_manual/core/ocs-share-api.rst +++ b/developer_manual/core/ocs-share-api.rst @@ -146,12 +146,60 @@ Creating a federated cloud share can be done via the local share endpoint, using of the share recipient as shareWith. See `Create a new Share`_ for more information. +List accepted Federated Cloud Shares +------------------------------------ + +Get all federated cloud shares the user has accepted. + +* Syntax: /remote_shares +* Method: GET + +* Result: XML with all accepted federated cloud shares + +Statuscodes: + +* 100 - successful + +Get information about a known Federated Cloud Share +--------------------------------------------------- + +Get information about a given received federated cloud that was sent from a remote instance. + +* Syntax: /remote_shares/** +* Method: GET + +* Arguments: share_id - (int) share ID as listed in the id field in the ``remote_shares`` list + +* Result: XML with the share information + +Statuscodes: + +* 100 - successful +* 404 - share doesn't exist + +Delete an accepted Federated Cloud Share +---------------------------------------- + +Locally delete a received federated cloud share that was sent from a remote instance. + +* Syntax: /remote_shares/** +* Method: DELETE + +* Arguments: share_id - (int) share ID as listed in the id field in the ``remote_shares`` list + +* Result: XML with the share information + +Statuscodes: + +* 100 - successful +* 404 - share doesn't exist + List pending Federated Cloud Shares ----------------------------------- Get all pending federated cloud shares the user has received. -* Syntax: /remote_shares +* Syntax: /remote_shares/pending * Method: GET * Result: XML with all pending federated cloud shares @@ -159,7 +207,6 @@ Get all pending federated cloud shares the user has received. Statuscodes: * 100 - successful -* 404 - couldn't fetch shares Accept a pending Federated Cloud Share -------------------------------------- @@ -169,7 +216,7 @@ Locally accept a received federated cloud share that was sent from a remote inst * Syntax: /remote_shares/pending/** * Method: POST -* Arguments: share_id - (int) share ID +* Arguments: share_id - (int) share ID as listed in the id field in the ``remote_shares/pending`` list * Result: XML with the share information @@ -183,10 +230,10 @@ Decline a pending Federated Cloud Share Locally decline a received federated cloud share that was sent from a remote instance. -* Syntax: /remote_shares/** +* Syntax: /remote_shares/pending/** * Method: DELETE -* Arguments: share_id - (int) share ID +* Arguments: share_id - (int) share ID as listed in the id field in the ``remote_shares/pending`` list * Result: XML with the share information