ari: User better nicknames for ARI operations
[asterisk/asterisk.git] / rest-api-templates / ari_resource.h.mustache
1 {{#api_declaration}}
2 /*
3  * Asterisk -- An open source telephony toolkit.
4  *
5  * {{{copyright}}}
6  *
7  * {{{author}}}
8  *
9  * See http://www.asterisk.org for more information about
10  * the Asterisk project. Please do not directly contact
11  * any of the maintainers of this project for assistance;
12  * the project provides a web site, mailing lists and IRC
13  * channels for your use.
14  *
15  * This program is free software, distributed under the terms of
16  * the GNU General Public License Version 2. See the LICENSE file
17  * at the top of the source tree.
18  */
19
20 /*! \file
21  *
22  * \brief Generated file - declares stubs to be implemented in
23  * res/ari/resource_{{name}}.c
24  *
25  * {{{description}}}
26  *
27  * \author {{{author}}}
28  */
29
30 /*
31 {{> do-not-edit}}
32  * This file is generated by a mustache template. Please see the original
33  * template in rest-api-templates/ari_resource.h.mustache
34  */
35
36 #ifndef _ASTERISK_RESOURCE_{{name_caps}}_H
37 #define _ASTERISK_RESOURCE_{{name_caps}}_H
38
39 #include "asterisk/ari.h"
40
41 {{#apis}}
42 {{#operations}}
43 /*! \brief Argument struct for ast_ari_{{c_name}}_{{c_nickname}}() */
44 struct ast_ari_{{c_name}}_{{c_nickname}}_args {
45 {{#parameters}}
46 {{#description}}
47 {{/description}}
48 {{^allow_multiple}}
49 {{#description}}
50         /*! \brief {{{description}}} */
51 {{/description}}
52         {{c_data_type}}{{c_space}}{{c_name}};
53 {{/allow_multiple}}
54 {{#allow_multiple}}
55         /*! \brief Array of {{{description}}} */
56         {{c_data_type}}{{c_space}}*{{c_name}};
57         /*! \brief Length of {{c_name}} array. */
58         size_t {{c_name}}_count;
59         /*! \brief Parsing context for {{c_name}}. */
60         char *{{c_name}}_parse;
61 {{/allow_multiple}}
62 {{/parameters}}
63 };
64 {{#is_req}}
65 /*!
66  * \brief {{summary}}
67 {{#notes}}
68  *
69  * {{{notes}}}
70 {{/notes}}
71  *
72  * \param headers HTTP headers
73  * \param args Swagger parameters
74  * \param[out] response HTTP response
75  */
76 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);
77 {{/is_req}}
78 {{#is_websocket}}
79 /*!
80  * \brief {{summary}}
81 {{#notes}}
82  *
83  * {{{notes}}}
84 {{/notes}}
85  *
86  * \param session ARI WebSocket.
87  * \param headers HTTP headers.
88  * \param args Swagger parameters.
89  */
90 void ast_ari_websocket_{{c_name}}_{{c_nickname}}(struct ast_ari_websocket_session *session, struct ast_variable *headers, struct ast_ari_{{c_name}}_{{c_nickname}}_args *args);
91 {{/is_websocket}}
92 {{/operations}}
93 {{/apis}}
94
95 #endif /* _ASTERISK_RESOURCE_{{name_caps}}_H */
96 {{/api_declaration}}