From a1c493358f8beb4aaea4e3c158572bc831294f42 Mon Sep 17 00:00:00 2001 From: Francis Lachapelle Date: Thu, 4 Jun 2015 14:36:58 -0400 Subject: [PATCH] Improve API documentation for appointment editor --- UI/Scheduler/UIxAppointmentEditor.m | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/UI/Scheduler/UIxAppointmentEditor.m b/UI/Scheduler/UIxAppointmentEditor.m index d32d35ffa..1b62cc8f9 100644 --- a/UI/Scheduler/UIxAppointmentEditor.m +++ b/UI/Scheduler/UIxAppointmentEditor.m @@ -366,18 +366,18 @@ } /** - * @api {post} /so/:username/Calendar/:calendarId/:appointmentId/save Save event + * @api {post} /so/:username/Calendar/:calendarId/:appointmentId/save(AsAppointment) Save event * @apiVersion 1.0.0 * @apiName PostEventSave * @apiGroup Calendar + * @apiDescription When saving a new event, the action URL must be saveAsAppointment, + * otherwise it is optional. * @apiExample {curl} Example usage: * curl -i http://localhost/SOGo/so/sogo1/Calendar/personal/71B6-54904400-1-7C308500.ics/save \ * -H 'Content-Type: application/json' \ * -d '{ "summary": "Meeting", "startDate": "2015-01-28", "startTime": "10:00", \ * "endDate": "2015-01-28", "endTime": "12:00" }' * - * Save in [iCalEvent+SOGo setAttributes:inContext:] - * * @apiParam {String} startDate Start date (YYYY-MM-DD) * @apiParam {String} startTime Start time (HH:MM) * @apiParam {String} endDate End date (YYYY-MM-DD) @@ -385,6 +385,8 @@ * @apiParam {Number} [isAllDay] 1 if event is all-day * @apiParam {Number} isTransparent 1 if the event is not opaque * + * ^_ Save in [iCalEvent+SOGo setAttributes:inContext:] + * * Save in [iCalEntityObject+SOGo setAttributes:inContext:] * * @apiParam {Number} [sendAppointmentNotifications] 0 if notifications must not be sent