Improve API documentation
This commit is contained in:
parent
f2587aa385
commit
6080e800d7
|
@ -91,12 +91,12 @@
|
||||||
* @apiExample {curl} Example usage:
|
* @apiExample {curl} Example usage:
|
||||||
* curl -i http://localhost/SOGo/so/sogo1/Calendar/personal/acls
|
* curl -i http://localhost/SOGo/so/sogo1/Calendar/personal/acls
|
||||||
*
|
*
|
||||||
* @apiSuccess (Success 200) {Object[]} users List of users with ACL for the folder
|
* @apiSuccess (Success 200) {Object[]} users List of users with ACL for the folder
|
||||||
* @apiSuccess (Success 200) {String} uid User ID
|
* @apiSuccess (Success 200) {String} users.uid User ID
|
||||||
* @apiSuccess (Success 200) {String} userClass Either 'normal-user', 'normal-group' or 'public-access'
|
* @apiSuccess (Success 200) {String} users.userClass Either 'normal-user', 'normal-group' or 'public-access'
|
||||||
* @apiSuccess (Success 200) {Number} isSubscribed 1 if the user is subscribed to the folder
|
* @apiSuccess (Success 200) {Number} users.isSubscribed 1 if the user is subscribed to the folder
|
||||||
* @apiSuccess (Success 200) {String} [cn] User fullname
|
* @apiSuccess (Success 200) {String} [users.cn] User fullname
|
||||||
* @apiSuccess (Success 200) {String} [c_email] User main email address
|
* @apiSuccess (Success 200) {String} [users.c_email] User main email address
|
||||||
*/
|
*/
|
||||||
- (id <WOActionResults>) aclsAction
|
- (id <WOActionResults>) aclsAction
|
||||||
{
|
{
|
||||||
|
|
|
@ -183,6 +183,21 @@
|
||||||
return response;
|
return response;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @api {get} /so/:username/:folderPath/acls Get ACLs
|
||||||
|
* @apiVersion 1.0.0
|
||||||
|
* @apiName GetAcls
|
||||||
|
* @apiGroup Common
|
||||||
|
* @apiExample {curl} Example usage:
|
||||||
|
* curl -i http://localhost/SOGo/so/sogo1/Calendar/personal/acls
|
||||||
|
*
|
||||||
|
* @apiSuccess (Success 200) {Object[]} users List of users with ACL for the folder
|
||||||
|
* @apiSuccess (Success 200) {String} users.uid User ID
|
||||||
|
* @apiSuccess (Success 200) {String} users.userClass Either 'normal-user', 'normal-group' or 'public-access'
|
||||||
|
* @apiSuccess (Success 200) {Number} users.isSubscribed 1 if the user is subscribed to the folder
|
||||||
|
* @apiSuccess (Success 200) {String} [users.cn] User fullname
|
||||||
|
* @apiSuccess (Success 200) {String} [users.c_email] User main email address
|
||||||
|
*/
|
||||||
- (id <WOActionResults>) userRightsAction
|
- (id <WOActionResults>) userRightsAction
|
||||||
{
|
{
|
||||||
id <WOActionResults> response;
|
id <WOActionResults> response;
|
||||||
|
|
Loading…
Reference in a new issue