amorfo77/sogo
1
0
Fork 0
mirror of https://github.com/inverse-inc/sogo.git synced 2026-05-22 03:45:25 +00:00
Code Issues Projects Releases Wiki Activity

Improve JSON API documentation

Browse Source
This commit is contained in:
Francis Lachapelle
2015-01-13 11:30:23 -05:00
parent 64615ea6fa
commit 8286fb68a4
7 changed files with 129 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
UI/MailerUI/UIxMailFolderActions.m
+8 -4
View File
@@ -54,10 +54,14 @@
@implementation UIxMailFolderActions
/**
* @api {post} /so/:username/Mail/:accountId/:parentMailboxPath/createFolder Create a mailbox
* @api {post} /so/:username/Mail/:accountId/:parentMailboxPath/createFolder Create mailbox
* @apiVersion 1.0.0
* @apiName PostCreateFolder
* @apiGroup Mail
* @apiExample {curl} Example usage:
* curl -i http://localhost/SOGo/so/sogo1/Mail/0/folderINBOX/createFolder \
* -H "Content-Type: application/json" \
* -d '{ "name": "test" }'
*
* @apiParam {String} name Name of the mailbox
*
@@ -92,7 +96,7 @@
jsonResponse = [NSDictionary dictionaryWithObject: [NSString stringWithFormat: errorFormat, folderName]
forKey: @"error"];
response = [self responseWithStatus: 500
andString: [jsonResponse jsonRepresentation]];
andJSONRepresentation: jsonResponse];
}
}
else
@@ -100,14 +104,14 @@
jsonResponse = [NSDictionary dictionaryWithObject: [self labelForKey: @"Missing 'name' parameter."]
forKey: @"error"];
response = [self responseWithStatus: 500
andString: [jsonResponse jsonRepresentation]];
andJSONRepresentation: jsonResponse];
}
return response;
}
/**
* @api {post} /so/:username/Mail/:accountId/:mailboxPath/renameFolder Rename a mailbox
* @api {post} /so/:username/Mail/:accountId/:mailboxPath/renameFolder Rename mailbox
* @apiVersion 1.0.0
* @apiName PostRenameFolder
* @apiGroup Mail