ARI: Remove unnecessary \briefs from automatically generated documentation
[asterisk/asterisk.git] / res / ari / resource_asterisk.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012 - 2013, Digium, Inc.
5  *
6  * David M. Lee, II <dlee@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Generated file - declares stubs to be implemented in
22  * res/ari/resource_asterisk.c
23  *
24  * Asterisk resources
25  *
26  * \author David M. Lee, II <dlee@digium.com>
27  */
28
29 /*
30  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
31  * !!!!!                               DO NOT EDIT                        !!!!!
32  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
33  * This file is generated by a mustache template. Please see the original
34  * template in rest-api-templates/ari_resource.h.mustache
35  */
36
37 #ifndef _ASTERISK_RESOURCE_ASTERISK_H
38 #define _ASTERISK_RESOURCE_ASTERISK_H
39
40 #include "asterisk/ari.h"
41
42 /*! Argument struct for ast_ari_asterisk_get_info() */
43 struct ast_ari_asterisk_get_info_args {
44         /*! Array of Filter information returned */
45         const char **only;
46         /*! Length of only array. */
47         size_t only_count;
48         /*! Parsing context for only. */
49         char *only_parse;
50 };
51 /*!
52  * \brief Body parsing function for /asterisk/info.
53  * \param body The JSON body from which to parse parameters.
54  * \param[out] args The args structure to parse into.
55  * \retval zero on success
56  * \retval non-zero on failure
57  */
58 int ast_ari_asterisk_get_info_parse_body(
59         struct ast_json *body,
60         struct ast_ari_asterisk_get_info_args *args);
61
62 /*!
63  * \brief Gets Asterisk system information.
64  *
65  * \param headers HTTP headers
66  * \param args Swagger parameters
67  * \param[out] response HTTP response
68  */
69 void ast_ari_asterisk_get_info(struct ast_variable *headers, struct ast_ari_asterisk_get_info_args *args, struct ast_ari_response *response);
70 /*! Argument struct for ast_ari_asterisk_get_global_var() */
71 struct ast_ari_asterisk_get_global_var_args {
72         /*! The variable to get */
73         const char *variable;
74 };
75 /*!
76  * \brief Body parsing function for /asterisk/variable.
77  * \param body The JSON body from which to parse parameters.
78  * \param[out] args The args structure to parse into.
79  * \retval zero on success
80  * \retval non-zero on failure
81  */
82 int ast_ari_asterisk_get_global_var_parse_body(
83         struct ast_json *body,
84         struct ast_ari_asterisk_get_global_var_args *args);
85
86 /*!
87  * \brief Get the value of a global variable.
88  *
89  * \param headers HTTP headers
90  * \param args Swagger parameters
91  * \param[out] response HTTP response
92  */
93 void ast_ari_asterisk_get_global_var(struct ast_variable *headers, struct ast_ari_asterisk_get_global_var_args *args, struct ast_ari_response *response);
94 /*! Argument struct for ast_ari_asterisk_set_global_var() */
95 struct ast_ari_asterisk_set_global_var_args {
96         /*! The variable to set */
97         const char *variable;
98         /*! The value to set the variable to */
99         const char *value;
100 };
101 /*!
102  * \brief Body parsing function for /asterisk/variable.
103  * \param body The JSON body from which to parse parameters.
104  * \param[out] args The args structure to parse into.
105  * \retval zero on success
106  * \retval non-zero on failure
107  */
108 int ast_ari_asterisk_set_global_var_parse_body(
109         struct ast_json *body,
110         struct ast_ari_asterisk_set_global_var_args *args);
111
112 /*!
113  * \brief Set the value of a global variable.
114  *
115  * \param headers HTTP headers
116  * \param args Swagger parameters
117  * \param[out] response HTTP response
118  */
119 void ast_ari_asterisk_set_global_var(struct ast_variable *headers, struct ast_ari_asterisk_set_global_var_args *args, struct ast_ari_response *response);
120
121 #endif /* _ASTERISK_RESOURCE_ASTERISK_H */