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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
{{#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/ari/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/ari_resource.h.mustache
*/
#ifndef _ASTERISK_RESOURCE_{{name_caps}}_H
#define _ASTERISK_RESOURCE_{{name_caps}}_H
#include "asterisk/ari.h"
{{#apis}}
{{#operations}}
/*! Argument struct for ast_ari_{{c_name}}_{{c_nickname}}() */
struct ast_ari_{{c_name}}_{{c_nickname}}_args {
{{#parameters}}
{{#description}}
{{/description}}
{{^allow_multiple}}
{{#description}}
/*! {{{description}}} */
{{/description}}
{{c_data_type}}{{c_space}}{{c_name}};
{{/allow_multiple}}
{{#allow_multiple}}
/*! Array of {{{description}}} */
{{c_data_type}}{{c_space}}*{{c_name}};
/*! Length of {{c_name}} array. */
size_t {{c_name}}_count;
/*! Parsing context for {{c_name}}. */
char *{{c_name}}_parse;
{{/allow_multiple}}
{{/parameters}}
};
{{#is_req}}
{{#parse_body}}
/*!
* \brief Body parsing function for {{path}}.
* \param body The JSON body from which to parse parameters.
* \param[out] args The args structure to parse into.
* \retval zero on success
* \retval non-zero on failure
*/
int ast_ari_{{c_name}}_{{c_nickname}}_parse_body(
struct ast_json *body,
struct ast_ari_{{c_name}}_{{c_nickname}}_args *args);
{{/parse_body}}
/*!
* \brief {{{summary}}}
{{#notes}}
*
* {{{notes}}}
{{/notes}}
*
{{#is_binary_response}}
* \param ser TCP/TLS session instance
{{/is_binary_response}}
* \param headers HTTP headers
* \param args Swagger parameters
* \param[out] response HTTP response
*/
{{^is_binary_response}}
void ast_ari_{{c_name}}_{{c_nickname}}(struct ast_variable *headers, struct ast_ari_{{c_name}}_{{c_nickname}}_args *args, struct ast_ari_response *response);
{{/is_binary_response}}
{{#is_binary_response}}
void ast_ari_{{c_name}}_{{c_nickname}}(struct ast_tcptls_session_instance *ser, struct ast_variable *headers, struct ast_ari_{{c_name}}_{{c_nickname}}_args *args, struct ast_ari_response *response);
{{/is_binary_response}}
{{/is_req}}
{{#is_websocket}}
/*!
* \brief {{{summary}}}
{{#notes}}
*
* {{{notes}}}
{{/notes}}
*
* \retval 0 success
* \retval -1 error
*/
int ast_ari_websocket_{{c_name}}_{{c_nickname}}_init(void);
/*!
* \brief {{{summary}}}
{{#notes}}
*
* {{{notes}}}
{{/notes}}
*
* \return Nothing
*/
void ast_ari_websocket_{{c_name}}_{{c_nickname}}_dtor(void);
/*!
* \brief {{summary}}
{{#notes}}
*
* {{{notes}}}
{{/notes}}
*
* \param ser HTTP TCP/TLS Server Session
* \param headers HTTP headers
* \param args Swagger parameters
* \param session_id The id of the current session.
*
* \retval 0 success
* \retval non-zero error
*/
int ast_ari_websocket_{{c_name}}_{{c_nickname}}_attempted(struct ast_tcptls_session_instance *ser,
struct ast_variable *headers, struct ast_ari_{{c_name}}_{{c_nickname}}_args *args, const char *session_id);
/*!
* \brief {{summary}}
{{#notes}}
*
* {{{notes}}}
{{/notes}}
*
* \param session ARI WebSocket.
* \param headers HTTP headers.
* \param args Swagger parameters.
* \param session_id The id of the current session.
*/
void ast_ari_websocket_{{c_name}}_{{c_nickname}}_established(struct ast_ari_websocket_session *session,
struct ast_variable *headers, struct ast_ari_{{c_name}}_{{c_nickname}}_args *args);
{{/is_websocket}}
{{/operations}}
{{/apis}}
#endif /* _ASTERISK_RESOURCE_{{name_caps}}_H */
{{/api_declaration}}
|
