documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Document OCS share api v2

Open MorrisJobke opened this issue 7 years ago • 11 comments

cc @schiessle @rullzer

MorrisJobke avatar Jan 12 '17 10:01 MorrisJobke

There is no v2 api

rullzer avatar Jan 12 '17 14:01 rullzer

v2.php?

MorrisJobke avatar Jan 12 '17 15:01 MorrisJobke

Aaah you mean the OCS endpoint. Has nothing to do with the sharing API. Sharing API is still on v1. ocs/vX.php/apps/files_sharing/api/v1/shares.

Difference between v1.php and v2.php is mainly that the http return code is now not always 200 :P But what exactly do you want documented?

rullzer avatar Jan 12 '17 15:01 rullzer

Difference between v1.php and v2.php is mainly that the http return code is now not always 200 :P But what exactly do you want documented?

Those changed return codes would be super nice to know ;)

MorrisJobke avatar Jan 12 '17 22:01 MorrisJobke

ok sure. Let me assign to myself. It is on the famous never ending TODO list ;)

rullzer avatar Jan 13 '17 08:01 rullzer

https://github.com/nextcloud/documentation/blob/8626051300fbf82b7ed09382a86ee236f0df4b9b/developer_manual/core/ocs-share-api.rst#L28-L28

s/100/200 & s/Statuscodes/HTTP statuscode

nickvergessen avatar Jan 13 '17 09:01 nickvergessen

https://github.com/nextcloud/documentation/blob/8626051300fbf82b7ed09382a86ee236f0df4b9b/developer_manual/core/ocs-share-api.rst#L28-L28

s/100/200 & s/Statuscodes/HTTP statuscode

But there is also a change for the case when you create a new share with password and the password is not allowed by the password policy app.

MorrisJobke avatar Jan 13 '17 10:01 MorrisJobke

So you want to document the 403 you get... that is it?

rullzer avatar Jan 13 '17 11:01 rullzer

So you want to document the 403 you get... that is it?

Basically ;) And all the other return codes that got adjusted ;)

MorrisJobke avatar Jan 16 '17 17:01 MorrisJobke

I just run into this issue because the serverinfo app uses v2.php but the documentation does only mention v1.php.

J0WI avatar Apr 24 '19 10:04 J0WI

An example POST request would be good too. I'm assuming the post body must be XML, but it's not described anywhere in the documentation.

jamesrom avatar Aug 07 '22 02:08 jamesrom