new: Added self-description of the deleteAttributes API to the api component

pull/2909/merge
iglocska 2018-03-13 04:56:58 +01:00
parent 85d3411610
commit 70f43d32d1
1 changed files with 14 additions and 1 deletions

View File

@ -12,6 +12,14 @@ class RestResponseComponent extends Component {
);
private $__descriptions = array(
'Attribute' => array(
'deleteSelected' => array(
'description' => "POST a list of attribute IDs in JSON format to this API to delete the given attributes. This API also expect an event ID passed via the URL or via the event_id key.",
'mandatory' => array('id'),
'optional' => array('event_id'),
'params' => array('event_id')
)
),
'Organisation' => array(
'admin_add' => array(
'description' => "POST an Organisation object in JSON format to this API to create a new organsiation.",
@ -106,7 +114,12 @@ class RestResponseComponent extends Component {
'description' => "POST or PUT a Tag object in JSON format to this API to create a edit an existing tag.",
'optional' => array('name', 'colour', 'exportable', 'hide_tag', 'org_id', 'user_id'),
'params' => array('tag_id')
)
),
'removeTag' => array(
'description' => "POST a request object in JSON format to this API to create detach a tag from an event.",
'mandatory' => array('event', 'tag'),
'params' => array('tag_id')
),
),
'User' => array(
'admin_add' => array(