Asterisk
/
asterisk
mirror of https://github.com/asterisk/asterisk
1
0
Fork 0
Code Issues Releases Wiki Activity

res_ari: Fix for Doxygen.

Browse Source 
ASTERISK-29756

Change-Id: I2f1c1eea1c902492b77b74de9950f20ebbb7e758
pull/24/head
Alexander Traud 3 years ago committed by Kevin Harwell
parent c30ed45c94
commit 634e3ebdb8
20 changed files with 405 additions and 353 deletions
Show Stats Download Patch File Download Diff File

22
include/asterisk/ari.h
Unescape View File

@ -54,6 +54,7 @@ struct ast_ari_response;
* \param get_params GET parameters from the HTTP request.
* \param path_vars Path variables from any wildcard path segments.
* \param headers HTTP headers from the HTTP requiest.
* \param body
* \param[out] response The RESTful response.
*/
typedef void (*stasis_rest_callback)(
@ -91,7 +92,7 @@ struct stasis_rest_handlers {
struct ast_ari_response {
/*! Response message */
struct ast_json *message;
/*! \r\n seperated response headers */
/*! \\r\\n seperated response headers */
struct ast_str *headers;
/*! HTTP response code.
* See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html */
@ -107,16 +108,16 @@ struct ast_ari_response {
/*!
* Add a resource for REST handling.
* \param handler Handler to add.
* \return 0 on success.
* \return non-zero on failure.
* \retval 0 on success.
* \retval non-zero on failure.
*/
int ast_ari_add_handler(struct stasis_rest_handlers *handler);
/*!
* Remove a resource for REST handling.
* \param handler Handler to add.
* \return 0 on success.
* \return non-zero on failure.
* \retval 0 on success.
* \retval non-zero on failure.
*/
int ast_ari_remove_handler(struct stasis_rest_handlers *handler);
@ -132,6 +133,7 @@ int ast_ari_remove_handler(struct stasis_rest_handlers *handler);
* \param method HTTP method.
* \param get_params HTTP \c GET parameters.
* \param headers HTTP headers.
* \param body
* \param[out] response RESTful HTTP response.
*/
void ast_ari_invoke(struct ast_tcptls_session_instance *ser,
@ -165,7 +167,7 @@ struct ast_ari_websocket_session;
* \param ws_session Underlying WebSocket session.
* \param validator Function to validate outgoing messages.
* \return New ARI WebSocket session.
* \return \c NULL on error.
* \retval NULL on error.
*/
struct ast_ari_websocket_session *ast_ari_websocket_session_create(
struct ast_websocket *ws_session, int (*validator)(struct ast_json *));
@ -175,7 +177,7 @@ struct ast_ari_websocket_session *ast_ari_websocket_session_create(
*
* \param session Session to read from.
* \return Message received.
* \return \c NULL if WebSocket could not be read.
* \retval NULL if WebSocket could not be read.
*/
struct ast_json *ast_ari_websocket_session_read(
struct ast_ari_websocket_session *session);
@ -185,8 +187,8 @@ struct ast_json *ast_ari_websocket_session_read(
*
* \param session Session to write to.
* \param message Message to send.
* \return 0 on success.
* \return Non-zero on error.
* \retval 0 on success.
* \retval Non-zero on error.
*/
int ast_ari_websocket_session_write(struct ast_ari_websocket_session *session,
struct ast_json *message);
@ -196,7 +198,7 @@ int ast_ari_websocket_session_write(struct ast_ari_websocket_session *session,
*
* \param session Session to query.
* \return Session ID.
* \return \c NULL on error.
* \retval NULL on error.
*/
const char *ast_ari_websocket_session_id(
const struct ast_ari_websocket_session *session);

464
res/ari/ari_model_validators.h
View File

File diff suppressed because it is too large Load Diff

8
res/ari/resource_bridges.c
Unescape View File

@ -52,7 +52,7 @@
* \param bridge_id ID of the bridge to lookup.
*
* \return Bridget.
* \return \c NULL if bridge does not exist.
* \retval NULL if bridge does not exist.
*/
static struct ast_bridge *find_bridge(
struct ast_ari_response *response,
@ -87,7 +87,7 @@ static struct ast_bridge *find_bridge(
* \param[out] response Response to fill with an error if control is not found.
* \param channel_id ID of the channel to lookup.
* \return Channel control object.
* \return \c NULL if control object does not exist.
* \retval NULL if control object does not exist.
*/
static struct stasis_app_control *find_channel_control(
struct ast_ari_response *response,
@ -343,6 +343,7 @@ static struct ast_channel *prepare_bridge_media_channel(const char *type)
* \param args_media_count number of media items in \c media
* \param args_lang language string split from arguments
* \param args_offset_ms milliseconds offset split from arguments
* \param args_skipms
* \param args_playback_id string to use for playback split from
* arguments (null valid)
* \param response ARI response being built
@ -352,7 +353,7 @@ static struct ast_channel *prepare_bridge_media_channel(const char *type)
* \param playback_url stores playback URL for use with response
*
* \retval -1 operation failed
* \retval operation was successful
* \return operation was successful
*/
static int ari_bridges_play_helper(const char **args_media,
size_t args_media_count,
@ -514,6 +515,7 @@ enum play_found_result {
* \param args_media_count number of media items in \c media
* \param args_lang language string split from arguments
* \param args_offset_ms milliseconds offset split from arguments
* \param args_skipms
* \param args_playback_id string to use for playback split from
* arguments (null valid)
* \param response ARI response being built

6
res/ari/resource_channels.c
Unescape View File

@ -147,7 +147,7 @@ static int channel_state_invalid(struct stasis_app_control *control,
* \param[out] response Response to fill with an error if control is not found.
* \param channel_id ID of the channel to lookup.
* \return Channel control object.
* \return \c NULL if control object does not exist.
* \retval NULL if control object does not exist.
*/
static struct stasis_app_control *find_control(
struct ast_ari_response *response,
@ -1726,8 +1726,8 @@ struct ast_datastore_info dialstring_info = {
*
* \param chan The channel on which to save the dialstring
* \param dialstring The dialstring to save
* \retval 0 SUCCESS!
* \reval -1 Failure :(
* \retval 0 on success.
* \retval -1 on error.
*/
static int save_dialstring(struct ast_channel *chan, const char *dialstring)
{

3
res/ari/resource_events.h
Unescape View File

@ -61,8 +61,6 @@ int ast_ari_websocket_events_event_websocket_init(void);
/*!
* \brief WebSocket connection for events.
*
* \return Nothing
*/
void ast_ari_websocket_events_event_websocket_dtor(void);
@ -86,7 +84,6 @@ int ast_ari_websocket_events_event_websocket_attempted(struct ast_tcptls_session
* \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_events_event_websocket_established(struct ast_ari_websocket_session *session,
struct ast_variable *headers, struct ast_ari_events_event_websocket_args *args);

6
res/res_ari.c
Unescape View File

@ -815,7 +815,7 @@ enum ast_json_encoding_format ast_ari_json_format(void)
*
* \param api_key API key query parameter
* \return User object for the authenticated user.
* \return \c NULL if authentication failed.
* \retval NULL if authentication failed.
*/
static struct ast_ari_conf_user *authenticate_api_key(const char *api_key)
{
@ -841,9 +841,9 @@ static struct ast_ari_conf_user *authenticate_api_key(const char *api_key)
* \brief Authenticate an HTTP request.
*
* \param get_params GET parameters of the request.
* \param header HTTP headers.
* \param headers HTTP headers.
* \return User object for the authenticated user.
* \return \c NULL if authentication failed.
* \retval NULL if authentication failed.
*/
static struct ast_ari_conf_user *authenticate_user(struct ast_variable *get_params,
struct ast_variable *headers)

10
res/res_ari_applications.c
Unescape View File

@ -52,9 +52,11 @@
/*!
* \brief Parameter parsing callback for /applications.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_applications_list_cb(
@ -102,9 +104,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /applications/{applicationName}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_applications_get_cb(
@ -198,9 +202,11 @@ int ast_ari_applications_subscribe_parse_body(
/*!
* \brief Parameter parsing callback for /applications/{applicationName}/subscription.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_applications_subscribe_cb(
@ -348,9 +354,11 @@ int ast_ari_applications_unsubscribe_parse_body(
/*!
* \brief Parameter parsing callback for /applications/{applicationName}/subscription.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_applications_unsubscribe_cb(
@ -469,9 +477,11 @@ int ast_ari_applications_filter_parse_body(
/*!
* \brief Parameter parsing callback for /applications/{applicationName}/eventFilter.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_applications_filter_cb(

32
res/res_ari_asterisk.c
Unescape View File

@ -52,9 +52,11 @@
/*!
* \brief Parameter parsing callback for /asterisk/config/dynamic/{configClass}/{objectType}/{id}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_asterisk_get_object_cb(
@ -124,9 +126,11 @@ int ast_ari_asterisk_update_object_parse_body(
/*!
* \brief Parameter parsing callback for /asterisk/config/dynamic/{configClass}/{objectType}/{id}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_asterisk_update_object_cb(
@ -191,9 +195,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /asterisk/config/dynamic/{configClass}/{objectType}/{id}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_asterisk_delete_object_cb(
@ -294,9 +300,11 @@ int ast_ari_asterisk_get_info_parse_body(
/*!
* \brief Parameter parsing callback for /asterisk/info.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_asterisk_get_info_cb(
@ -397,9 +405,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /asterisk/ping.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_asterisk_ping_cb(
@ -447,9 +457,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /asterisk/modules.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_asterisk_list_modules_cb(
@ -497,9 +509,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /asterisk/modules/{moduleName}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_asterisk_get_module_cb(
@ -556,9 +570,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /asterisk/modules/{moduleName}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_asterisk_load_module_cb(
@ -614,9 +630,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /asterisk/modules/{moduleName}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_asterisk_unload_module_cb(
@ -673,9 +691,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /asterisk/modules/{moduleName}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_asterisk_reload_module_cb(
@ -732,9 +752,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /asterisk/logging.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_asterisk_list_log_channels_cb(
@ -795,9 +817,11 @@ int ast_ari_asterisk_add_log_parse_body(
/*!
* \brief Parameter parsing callback for /asterisk/logging/{logChannelName}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_asterisk_add_log_cb(
@ -864,9 +888,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /asterisk/logging/{logChannelName}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_asterisk_delete_log_cb(
@ -922,9 +948,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /asterisk/logging/{logChannelName}/rotate.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_asterisk_rotate_log_cb(
@ -993,9 +1021,11 @@ int ast_ari_asterisk_get_global_var_parse_body(
/*!
* \brief Parameter parsing callback for /asterisk/variable.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_asterisk_get_global_var_cb(
@ -1072,9 +1102,11 @@ int ast_ari_asterisk_set_global_var_parse_body(
/*!
* \brief Parameter parsing callback for /asterisk/variable.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_asterisk_set_global_var_cb(

28
res/res_ari_bridges.c
Unescape View File

@ -54,9 +54,11 @@
/*!
* \brief Parameter parsing callback for /bridges.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_bridges_list_cb(
@ -125,9 +127,11 @@ int ast_ari_bridges_create_parse_body(
/*!
* \brief Parameter parsing callback for /bridges.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_bridges_create_cb(
@ -209,9 +213,11 @@ int ast_ari_bridges_create_with_id_parse_body(
/*!
* \brief Parameter parsing callback for /bridges/{bridgeId}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_bridges_create_with_id_cb(
@ -279,9 +285,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /bridges/{bridgeId}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_bridges_get_cb(
@ -337,9 +345,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /bridges/{bridgeId}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_bridges_destroy_cb(
@ -449,9 +459,11 @@ int ast_ari_bridges_add_channel_parse_body(
/*!
* \brief Parameter parsing callback for /bridges/{bridgeId}/addChannel.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_bridges_add_channel_cb(
@ -612,9 +624,11 @@ int ast_ari_bridges_remove_channel_parse_body(
/*!
* \brief Parameter parsing callback for /bridges/{bridgeId}/removeChannel.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_bridges_remove_channel_cb(
@ -725,9 +739,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /bridges/{bridgeId}/videoSource/{channelId}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_bridges_set_video_source_cb(
@ -788,9 +804,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /bridges/{bridgeId}/videoSource.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_bridges_clear_video_source_cb(
@ -859,9 +877,11 @@ int ast_ari_bridges_start_moh_parse_body(
/*!
* \brief Parameter parsing callback for /bridges/{bridgeId}/moh.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_bridges_start_moh_cb(
@ -928,9 +948,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /bridges/{bridgeId}/moh.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_bridges_stop_moh_cb(
@ -1041,9 +1063,11 @@ int ast_ari_bridges_play_parse_body(
/*!
* \brief Parameter parsing callback for /bridges/{bridgeId}/play.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_bridges_play_cb(
@ -1214,9 +1238,11 @@ int ast_ari_bridges_play_with_id_parse_body(
/*!
* \brief Parameter parsing callback for /bridges/{bridgeId}/play/{playbackId}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_bridges_play_with_id_cb(
@ -1374,9 +1400,11 @@ int ast_ari_bridges_record_parse_body(
/*!
* \brief Parameter parsing callback for /bridges/{bridgeId}/record.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_bridges_record_cb(

62
res/res_ari_channels.c
Unescape View File

@ -56,9 +56,11 @@
/*!
* \brief Parameter parsing callback for /channels.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_list_cb(
@ -167,9 +169,11 @@ int ast_ari_channels_originate_parse_body(
/*!
* \brief Parameter parsing callback for /channels.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_originate_cb(
@ -300,9 +304,11 @@ int ast_ari_channels_create_parse_body(
/*!
* \brief Parameter parsing callback for /channels/create.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_create_cb(
@ -377,9 +383,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /channels/{channelId}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_get_cb(
@ -492,9 +500,11 @@ int ast_ari_channels_originate_with_id_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_originate_with_id_cb(
@ -608,9 +618,11 @@ int ast_ari_channels_hangup_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_hangup_cb(
@ -705,9 +717,11 @@ int ast_ari_channels_continue_in_dialplan_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/continue.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_continue_in_dialplan_cb(
@ -801,9 +815,11 @@ int ast_ari_channels_move_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/move.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_move_cb(
@ -886,9 +902,11 @@ int ast_ari_channels_redirect_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/redirect.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_redirect_cb(
@ -958,9 +976,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /channels/{channelId}/answer.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_answer_cb(
@ -1018,9 +1038,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /channels/{channelId}/ring.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_ring_cb(
@ -1078,9 +1100,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /channels/{channelId}/ring.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_ring_stop_cb(
@ -1167,9 +1191,11 @@ int ast_ari_channels_send_dtmf_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/dtmf.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_send_dtmf_cb(
@ -1263,9 +1289,11 @@ int ast_ari_channels_mute_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/mute.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_mute_cb(
@ -1346,9 +1374,11 @@ int ast_ari_channels_unmute_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/mute.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_unmute_cb(
@ -1416,9 +1446,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /channels/{channelId}/hold.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_hold_cb(
@ -1476,9 +1508,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /channels/{channelId}/hold.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_unhold_cb(
@ -1549,9 +1583,11 @@ int ast_ari_channels_start_moh_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/moh.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_start_moh_cb(
@ -1619,9 +1655,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /channels/{channelId}/moh.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_stop_moh_cb(
@ -1679,9 +1717,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /channels/{channelId}/silence.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_start_silence_cb(
@ -1739,9 +1779,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /channels/{channelId}/silence.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_stop_silence_cb(
@ -1853,9 +1895,11 @@ int ast_ari_channels_play_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/play.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_play_cb(
@ -2027,9 +2071,11 @@ int ast_ari_channels_play_with_id_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/play/{playbackId}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_play_with_id_cb(
@ -2188,9 +2234,11 @@ int ast_ari_channels_record_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/record.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_record_cb(
@ -2290,9 +2338,11 @@ int ast_ari_channels_get_channel_var_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/variable.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_get_channel_var_cb(
@ -2377,9 +2427,11 @@ int ast_ari_channels_set_channel_var_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/variable.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_set_channel_var_cb(
@ -2479,9 +2531,11 @@ int ast_ari_channels_snoop_channel_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/snoop.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_snoop_channel_cb(
@ -2585,9 +2639,11 @@ int ast_ari_channels_snoop_channel_with_id_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/snoop/{snoopId}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_snoop_channel_with_id_cb(
@ -2683,9 +2739,11 @@ int ast_ari_channels_dial_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/dial.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_dial_cb(
@ -2755,9 +2813,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /channels/{channelId}/rtp_statistics.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_rtpstatistics_cb(
@ -2858,9 +2918,11 @@ int ast_ari_channels_external_media_parse_body(
/*!
* \brief Parameter parsing callback for /channels/externalMedia.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_external_media_cb(

8
res/res_ari_device_states.c
Unescape View File

@ -53,9 +53,11 @@
/*!
* \brief Parameter parsing callback for /deviceStates.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_device_states_list_cb(
@ -103,9 +105,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /deviceStates/{deviceName}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_device_states_get_cb(
@ -173,9 +177,11 @@ int ast_ari_device_states_update_parse_body(
/*!
* \brief Parameter parsing callback for /deviceStates/{deviceName}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_device_states_update_cb(
@ -242,9 +248,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /deviceStates/{deviceName}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_device_states_delete_cb(

10
res/res_ari_endpoints.c
Unescape View File

@ -52,9 +52,11 @@
/*!
* \brief Parameter parsing callback for /endpoints.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_endpoints_list_cb(
@ -123,9 +125,11 @@ int ast_ari_endpoints_send_message_parse_body(
/*!
* \brief Parameter parsing callback for /endpoints/sendMessage.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_endpoints_send_message_cb(
@ -189,9 +193,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /endpoints/{tech}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_endpoints_list_by_tech_cb(
@ -247,9 +253,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /endpoints/{tech}/{resource}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_endpoints_get_cb(
@ -326,9 +334,11 @@ int ast_ari_endpoints_send_message_to_endpoint_parse_body(
/*!
* \brief Parameter parsing callback for /endpoints/{tech}/{resource}/sendMessage.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_endpoints_send_message_to_endpoint_cb(

2
res/res_ari_events.c
Unescape View File

@ -282,9 +282,11 @@ int ast_ari_events_user_event_parse_body(
/*!
* \brief Parameter parsing callback for /events/user/{eventName}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_events_user_event_cb(

8
res/res_ari_mailboxes.c
Unescape View File

@ -53,9 +53,11 @@
/*!
* \brief Parameter parsing callback for /mailboxes.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_mailboxes_list_cb(
@ -103,9 +105,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /mailboxes/{mailboxName}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_mailboxes_get_cb(
@ -178,9 +182,11 @@ int ast_ari_mailboxes_update_parse_body(
/*!
* \brief Parameter parsing callback for /mailboxes/{mailboxName}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_mailboxes_update_cb(
@ -249,9 +255,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /mailboxes/{mailboxName}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_mailboxes_delete_cb(

6
res/res_ari_playbacks.c
Unescape View File

@ -53,9 +53,11 @@
/*!
* \brief Parameter parsing callback for /playbacks/{playbackId}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_playbacks_get_cb(
@ -111,9 +113,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /playbacks/{playbackId}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_playbacks_stop_cb(
@ -182,9 +186,11 @@ int ast_ari_playbacks_control_parse_body(
/*!
* \brief Parameter parsing callback for /playbacks/{playbackId}/control.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_playbacks_control_cb(

24
res/res_ari_recordings.c
Unescape View File

@ -53,9 +53,11 @@
/*!
* \brief Parameter parsing callback for /recordings/stored.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_recordings_list_stored_cb(
@ -103,9 +105,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /recordings/stored/{recordingName}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_recordings_get_stored_cb(
@ -161,9 +165,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /recordings/stored/{recordingName}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_recordings_delete_stored_cb(
@ -219,9 +225,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /recordings/stored/{recordingName}/file.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_recordings_get_stored_file_cb(
@ -291,9 +299,11 @@ int ast_ari_recordings_copy_stored_parse_body(
/*!
* \brief Parameter parsing callback for /recordings/stored/{recordingName}/copy.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_recordings_copy_stored_cb(
@ -360,9 +370,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /recordings/live/{recordingName}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_recordings_get_live_cb(
@ -418,9 +430,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /recordings/live/{recordingName}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_recordings_cancel_cb(
@ -476,9 +490,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /recordings/live/{recordingName}/stop.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_recordings_stop_cb(
@ -534,9 +550,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /recordings/live/{recordingName}/pause.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_recordings_pause_cb(
@ -593,9 +611,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /recordings/live/{recordingName}/pause.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_recordings_unpause_cb(
@ -652,9 +672,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /recordings/live/{recordingName}/mute.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_recordings_mute_cb(
@ -711,9 +733,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /recordings/live/{recordingName}/mute.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_recordings_unmute_cb(

4
res/res_ari_sounds.c
Unescape View File

@ -69,9 +69,11 @@ int ast_ari_sounds_list_parse_body(
/*!
* \brief Parameter parsing callback for /sounds.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_sounds_list_cb(
@ -133,9 +135,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /sounds/{soundId}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_sounds_get_cb(

50
rest-api-templates/ari_model_validators.h.mustache
Unescape View File

@ -46,8 +46,8 @@
* \brief Validator for native Swagger void.
*
* \param json JSON object to validate.
* \returns True (non-zero) if valid.
* \returns False (zero) if invalid.
* \retval True (non-zero) if valid.
* \retval False (zero) if invalid.
*/
int ast_ari_validate_void(struct ast_json *json);
@ -55,8 +55,8 @@ int ast_ari_validate_void(struct ast_json *json);
* \brief Validator for native Swagger object.
*
* \param json JSON object to validate.
* \returns True (non-zero) if valid.
* \returns False (zero) if invalid.
* \retval True (non-zero) if valid.
* \retval False (zero) if invalid.
*/
int ast_ari_validate_object(struct ast_json *json);
@ -64,8 +64,8 @@ int ast_ari_validate_object(struct ast_json *json);
* \brief Validator for native Swagger byte.
*
* \param json JSON object to validate.
* \returns True (non-zero) if valid.
* \returns False (zero) if invalid.
* \retval True (non-zero) if valid.
* \retval False (zero) if invalid.
*/
int ast_ari_validate_byte(struct ast_json *json);
@ -73,8 +73,8 @@ int ast_ari_validate_byte(struct ast_json *json);
* \brief Validator for native Swagger boolean.
*
* \param json JSON object to validate.
* \returns True (non-zero) if valid.
* \returns False (zero) if invalid.
* \retval True (non-zero) if valid.
* \retval False (zero) if invalid.
*/
int ast_ari_validate_boolean(struct ast_json *json);
@ -82,8 +82,8 @@ int ast_ari_validate_boolean(struct ast_json *json);
* \brief Validator for native Swagger int.
*
* \param json JSON object to validate.
* \returns True (non-zero) if valid.
* \returns False (zero) if invalid.
* \retval True (non-zero) if valid.
* \retval False (zero) if invalid.
*/
int ast_ari_validate_int(struct ast_json *json);
@ -91,8 +91,8 @@ int ast_ari_validate_int(struct ast_json *json);
* \brief Validator for native Swagger long.
*
* \param json JSON object to validate.
* \returns True (non-zero) if valid.
* \returns False (zero) if invalid.
* \retval True (non-zero) if valid.
* \retval False (zero) if invalid.
*/
int ast_ari_validate_long(struct ast_json *json);
@ -100,8 +100,8 @@ int ast_ari_validate_long(struct ast_json *json);
* \brief Validator for native Swagger float.
*
* \param json JSON object to validate.
* \returns True (non-zero) if valid.
* \returns False (zero) if invalid.
* \retval True (non-zero) if valid.
* \retval False (zero) if invalid.
*/
int ast_ari_validate_float(struct ast_json *json);
@ -109,8 +109,8 @@ int ast_ari_validate_float(struct ast_json *json);
* \brief Validator for native Swagger double.
*
* \param json JSON object to validate.
* \returns True (non-zero) if valid.
* \returns False (zero) if invalid.
* \retval True (non-zero) if valid.
* \retval False (zero) if invalid.
*/
int ast_ari_validate_double(struct ast_json *json);
@ -118,8 +118,8 @@ int ast_ari_validate_double(struct ast_json *json);
* \brief Validator for native Swagger string.
*
* \param json JSON object to validate.
* \returns True (non-zero) if valid.
* \returns False (zero) if invalid.
* \retval True (non-zero) if valid.
* \retval False (zero) if invalid.
*/
int ast_ari_validate_string(struct ast_json *json);
@ -127,8 +127,8 @@ int ast_ari_validate_string(struct ast_json *json);
* \brief Validator for native Swagger date.
*
* \param json JSON object to validate.
* \returns True (non-zero) if valid.
* \returns False (zero) if invalid.
* \retval True (non-zero) if valid.
* \retval False (zero) if invalid.
*/
int ast_ari_validate_date(struct ast_json *json);
@ -137,8 +137,8 @@ int ast_ari_validate_date(struct ast_json *json);
*
* \param json JSON object to validate.
* \param fn Validator to call on every element in the array.
* \returns True (non-zero) if valid.
* \returns False (zero) if invalid.
* \retval True (non-zero) if valid.
* \retval False (zero) if invalid.
*/
int ast_ari_validate_list(struct ast_json *json, int (*fn)(struct ast_json *));
@ -158,15 +158,13 @@ typedef int (*ari_validator)(struct ast_json *json);
* {{{description_dox}}}
*
* \param json JSON object to validate.
* \returns True (non-zero) if valid.
* \returns False (zero) if invalid.
* \retval True (non-zero) if valid.
* \retval False (zero) if invalid.
*/
int ast_ari_validate_{{c_id}}(struct ast_json *json);
/*!
* \brief Function pointer to ast_ari_validate_{{c_id}}().
*
* See \ref ast_ari_model_validators.h for more details.
*/
ari_validator ast_ari_validate_{{c_id}}_fn(void);
{{/models}}

3
rest-api-templates/ari_resource.h.mustache
Unescape View File

@ -116,8 +116,6 @@ int ast_ari_websocket_{{c_name}}_{{c_nickname}}_init(void);
*
* {{{notes}}}
{{/notes}}
*
* \return Nothing
*/
void ast_ari_websocket_{{c_name}}_{{c_nickname}}_dtor(void);
@ -149,7 +147,6 @@ int ast_ari_websocket_{{c_name}}_{{c_nickname}}_attempted(struct ast_tcptls_sess
* \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);

2
rest-api-templates/res_ari_resource.c.mustache
Unescape View File

@ -71,9 +71,11 @@
{{> body_parsing}}
/*!
* \brief Parameter parsing callback for {{path}}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_{{c_name}}_{{c_nickname}}_cb(

Write Preview
Loading…
Cancel
Save