summaryrefslogtreecommitdiff
path: root/rest-api-templates/stasis_json_resource.h.mustache
blob: 8cfd2c1f7e185b0a635d39ecaa99bd08dd06aff8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
{{#api_declaration}}
/*
 * Asterisk -- An open source telephony toolkit.
 *
 * {{{copyright}}}
 *
 * {{{author}}}
 *
 * See http://www.asterisk.org for more information about
 * the Asterisk project. Please do not directly contact
 * any of the maintainers of this project for assistance;
 * the project provides a web site, mailing lists and IRC
 * channels for your use.
 *
 * This program is free software, distributed under the terms of
 * the GNU General Public License Version 2. See the LICENSE file
 * at the top of the source tree.
 */

/*! \file
 *
 * \brief Generated file - declares stubs to be implemented in
 * res/stasis_json/resource_{{name}}.c
 *
 * {{{description}}}
 *
 * \author {{{author}}}
 */

/*
{{> do-not-edit}}
 * This file is generated by a mustache template. Please see the original
 * template in rest-api-templates/stasis_http_resource.h.mustache
 */

#ifndef _ASTERISK_RESOURCE_{{name_caps}}_H
#define _ASTERISK_RESOURCE_{{name_caps}}_H

{{#has_events}}
struct ast_channel_snapshot;
struct ast_bridge_snapshot;

{{#events}}
/*!
 * \brief {{description}}
{{#notes}}
 *
 * {{{notes}}}
{{/notes}}
 *
{{#channel}}
 * \param channel {{#channel_desc}}{{channel_desc}}{{/channel_desc}}{{^channel_desc}}The channel to be used to generate this event{{/channel_desc}}
{{/channel}}
{{#bridge}}
 * \param bridge {{#bridge_desc}}{{bridge_desc}}{{/bridge_desc}}{{^bridge_desc}}The bridge to be used to generate this event{{/bridge_desc}}
{{/bridge}}
{{#has_properties}}
 * \param blob JSON blob containing the following parameters:
{{/has_properties}}
{{#properties}}
 * - {{name}}: {{type}} {{#description}}- {{description}}{{/description}}{{#required}} (required){{/required}}
{{/properties}}
 *
 * \retval NULL on error
 * \retval JSON (ast_json) describing the event
 */
{{> event_function_decl}}
	);

{{/events}}
{{/has_events}}
/*
 * JSON models
 *
{{#models}}
 * {{id}}
{{#properties}}
 * - {{name}}: {{type}}{{#required}} (required){{/required}}
{{/properties}}
{{/models}} */

#endif /* _ASTERISK_RESOURCE_{{name_caps}}_H */
{{/api_declaration}}