LupusNobilis
/
sogo
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improve API documentation for appointment editor

pull/91/head
Francis Lachapelle 2015-06-04 14:36:58 -04:00
parent 4cece88a42
commit a1c493358f
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
UI/Scheduler/UIxAppointmentEditor.m
View File

@ -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