From 17d5ef3a94e453050ca6397c53a9ce0754572212 Mon Sep 17 00:00:00 2001 From: Alexander Traud Date: Wed, 17 Nov 2021 13:18:32 +0100 Subject: [PATCH] res_ari: Fix for Doxygen. ASTERISK-29756 Change-Id: I2f1c1eea1c902492b77b74de9950f20ebbb7e758 --- include/asterisk/ari.h | 22 +- res/ari/ari_model_validators.h | 464 ++++++------------ res/ari/resource_bridges.c | 8 +- res/ari/resource_channels.c | 6 +- res/ari/resource_events.h | 3 - res/res_ari.c | 6 +- res/res_ari_applications.c | 10 + res/res_ari_asterisk.c | 32 ++ res/res_ari_bridges.c | 28 ++ res/res_ari_channels.c | 62 +++ res/res_ari_device_states.c | 8 + res/res_ari_endpoints.c | 10 + res/res_ari_events.c | 2 + res/res_ari_mailboxes.c | 8 + res/res_ari_playbacks.c | 6 + res/res_ari_recordings.c | 24 + res/res_ari_sounds.c | 4 + .../ari_model_validators.h.mustache | 50 +- rest-api-templates/ari_resource.h.mustache | 3 - .../res_ari_resource.c.mustache | 2 + 20 files changed, 405 insertions(+), 353 deletions(-) diff --git a/include/asterisk/ari.h b/include/asterisk/ari.h index 17464c03fb..79e28f23f8 100644 --- a/include/asterisk/ari.h +++ b/include/asterisk/ari.h @@ -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); diff --git a/res/ari/ari_model_validators.h b/res/ari/ari_model_validators.h index e34c2e4990..583cba33a4 100644 --- a/res/ari/ari_model_validators.h +++ b/res/ari/ari_model_validators.h @@ -48,8 +48,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); @@ -57,8 +57,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); @@ -66,8 +66,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); @@ -75,8 +75,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); @@ -84,8 +84,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); @@ -93,8 +93,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); @@ -102,8 +102,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); @@ -111,8 +111,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); @@ -120,8 +120,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); @@ -129,8 +129,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); @@ -139,8 +139,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 *)); @@ -157,15 +157,13 @@ typedef int (*ari_validator)(struct ast_json *json); * Asterisk system information * * \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_asterisk_info(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_asterisk_info(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_asterisk_info_fn(void); @@ -175,15 +173,13 @@ ari_validator ast_ari_validate_asterisk_info_fn(void); * Asterisk ping information * * \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_asterisk_ping(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_asterisk_ping(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_asterisk_ping_fn(void); @@ -193,15 +189,13 @@ ari_validator ast_ari_validate_asterisk_ping_fn(void); * Info about how Asterisk was built * * \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_build_info(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_build_info(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_build_info_fn(void); @@ -211,15 +205,13 @@ ari_validator ast_ari_validate_build_info_fn(void); * Info about Asterisk configuration * * \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_config_info(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_config_info(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_config_info_fn(void); @@ -229,15 +221,13 @@ ari_validator ast_ari_validate_config_info_fn(void); * A key/value pair that makes up part of a configuration 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_config_tuple(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_config_tuple(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_config_tuple_fn(void); @@ -247,15 +237,13 @@ ari_validator ast_ari_validate_config_tuple_fn(void); * Details of an Asterisk log channel * * \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_log_channel(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_log_channel(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_log_channel_fn(void); @@ -265,15 +253,13 @@ ari_validator ast_ari_validate_log_channel_fn(void); * Details of an Asterisk module * * \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_module(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_module(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_module_fn(void); @@ -283,15 +269,13 @@ ari_validator ast_ari_validate_module_fn(void); * Effective user/group id * * \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_set_id(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_set_id(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_set_id_fn(void); @@ -301,15 +285,13 @@ ari_validator ast_ari_validate_set_id_fn(void); * Info about Asterisk status * * \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_status_info(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_status_info(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_status_info_fn(void); @@ -319,15 +301,13 @@ ari_validator ast_ari_validate_status_info_fn(void); * Info about Asterisk * * \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_system_info(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_system_info(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_system_info_fn(void); @@ -337,15 +317,13 @@ ari_validator ast_ari_validate_system_info_fn(void); * The value of a channel variable * * \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_variable(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_variable(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_variable_fn(void); @@ -357,15 +335,13 @@ ari_validator ast_ari_validate_variable_fn(void); * Unlike most resources, which have a single unique identifier, an endpoint is uniquely identified by the technology/resource pair. * * \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_endpoint(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_endpoint(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_endpoint_fn(void); @@ -375,15 +351,13 @@ ari_validator ast_ari_validate_endpoint_fn(void); * A text message. * * \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_text_message(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_text_message(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_text_message_fn(void); @@ -393,15 +367,13 @@ ari_validator ast_ari_validate_text_message_fn(void); * Caller identification * * \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_caller_id(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_caller_id(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_caller_id_fn(void); @@ -411,15 +383,13 @@ ari_validator ast_ari_validate_caller_id_fn(void); * A specific communication connection between Asterisk and an Endpoint. * * \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_channel(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_channel(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_channel_fn(void); @@ -429,15 +399,13 @@ ari_validator ast_ari_validate_channel_fn(void); * Dialed channel information. * * \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_dialed(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_dialed(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_dialed_fn(void); @@ -447,15 +415,13 @@ ari_validator ast_ari_validate_dialed_fn(void); * Dialplan location (context/extension/priority) * * \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_dialplan_cep(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_dialplan_cep(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_dialplan_cep_fn(void); @@ -465,15 +431,13 @@ ari_validator ast_ari_validate_dialplan_cep_fn(void); * A statistics of a RTP. * * \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_rtpstat(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_rtpstat(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_rtpstat_fn(void); @@ -485,15 +449,13 @@ ari_validator ast_ari_validate_rtpstat_fn(void); * Everyone on the bridge receives the same audio. * * \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_bridge(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_bridge(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_bridge_fn(void); @@ -503,15 +465,13 @@ ari_validator ast_ari_validate_bridge_fn(void); * A recording that is in progress * * \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_live_recording(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_live_recording(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_live_recording_fn(void); @@ -521,15 +481,13 @@ ari_validator ast_ari_validate_live_recording_fn(void); * A past recording that may be played back. * * \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_stored_recording(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_stored_recording(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_stored_recording_fn(void); @@ -539,15 +497,13 @@ ari_validator ast_ari_validate_stored_recording_fn(void); * Identifies the format and language of a sound file * * \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_format_lang_pair(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_format_lang_pair(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_format_lang_pair_fn(void); @@ -557,15 +513,13 @@ ari_validator ast_ari_validate_format_lang_pair_fn(void); * A media file that may be played back. * * \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_sound(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_sound(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_sound_fn(void); @@ -575,15 +529,13 @@ ari_validator ast_ari_validate_sound_fn(void); * Object representing the playback of media to a channel * * \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_playback(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_playback(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_playback_fn(void); @@ -593,15 +545,13 @@ ari_validator ast_ari_validate_playback_fn(void); * Represents the state of a device. * * \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_device_state(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_device_state(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_device_state_fn(void); @@ -611,15 +561,13 @@ ari_validator ast_ari_validate_device_state_fn(void); * Represents the state of a mailbox. * * \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_mailbox(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_mailbox(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_mailbox_fn(void); @@ -629,15 +577,13 @@ ari_validator ast_ari_validate_mailbox_fn(void); * Notification that trying to move a channel to another Stasis application failed. * * \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_application_move_failed(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_application_move_failed(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_application_move_failed_fn(void); @@ -649,15 +595,13 @@ ari_validator ast_ari_validate_application_move_failed_fn(void); * An application may only be subscribed to by a single WebSocket at a time. If multiple WebSockets attempt to subscribe to the same application, the newer WebSocket wins, and the older one receives this event. * * \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_application_replaced(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_application_replaced(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_application_replaced_fn(void); @@ -667,15 +611,13 @@ ari_validator ast_ari_validate_application_replaced_fn(void); * Notification that an attended transfer has occurred. * * \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_bridge_attended_transfer(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_bridge_attended_transfer(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_bridge_attended_transfer_fn(void); @@ -685,15 +627,13 @@ ari_validator ast_ari_validate_bridge_attended_transfer_fn(void); * Notification that a blind transfer has occurred. * * \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_bridge_blind_transfer(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_bridge_blind_transfer(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_bridge_blind_transfer_fn(void); @@ -703,15 +643,13 @@ ari_validator ast_ari_validate_bridge_blind_transfer_fn(void); * Notification that a bridge has been created. * * \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_bridge_created(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_bridge_created(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_bridge_created_fn(void); @@ -721,15 +659,13 @@ ari_validator ast_ari_validate_bridge_created_fn(void); * Notification that a bridge has been destroyed. * * \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_bridge_destroyed(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_bridge_destroyed(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_bridge_destroyed_fn(void); @@ -739,15 +675,13 @@ ari_validator ast_ari_validate_bridge_destroyed_fn(void); * Notification that one bridge has merged into another. * * \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_bridge_merged(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_bridge_merged(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_bridge_merged_fn(void); @@ -757,15 +691,13 @@ ari_validator ast_ari_validate_bridge_merged_fn(void); * Notification that the source of video in a bridge has changed. * * \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_bridge_video_source_changed(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_bridge_video_source_changed(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_bridge_video_source_changed_fn(void); @@ -775,15 +707,13 @@ ari_validator ast_ari_validate_bridge_video_source_changed_fn(void); * Channel changed Caller ID. * * \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_channel_caller_id(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_channel_caller_id(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_channel_caller_id_fn(void); @@ -793,15 +723,13 @@ ari_validator ast_ari_validate_channel_caller_id_fn(void); * Channel changed Connected Line. * * \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_channel_connected_line(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_channel_connected_line(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_channel_connected_line_fn(void); @@ -811,15 +739,13 @@ ari_validator ast_ari_validate_channel_connected_line_fn(void); * Notification that a channel has been created. * * \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_channel_created(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_channel_created(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_channel_created_fn(void); @@ -829,15 +755,13 @@ ari_validator ast_ari_validate_channel_created_fn(void); * Notification that a channel has been destroyed. * * \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_channel_destroyed(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_channel_destroyed(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_channel_destroyed_fn(void); @@ -847,15 +771,13 @@ ari_validator ast_ari_validate_channel_destroyed_fn(void); * Channel changed location in the dialplan. * * \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_channel_dialplan(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_channel_dialplan(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_channel_dialplan_fn(void); @@ -867,15 +789,13 @@ ari_validator ast_ari_validate_channel_dialplan_fn(void); * This event is sent when the DTMF ends. There is no notification about the start of DTMF * * \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_channel_dtmf_received(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_channel_dtmf_received(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_channel_dtmf_received_fn(void); @@ -885,15 +805,13 @@ ari_validator ast_ari_validate_channel_dtmf_received_fn(void); * Notification that a channel has entered a bridge. * * \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_channel_entered_bridge(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_channel_entered_bridge(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_channel_entered_bridge_fn(void); @@ -903,15 +821,13 @@ ari_validator ast_ari_validate_channel_entered_bridge_fn(void); * A hangup was requested on the channel. * * \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_channel_hangup_request(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_channel_hangup_request(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_channel_hangup_request_fn(void); @@ -921,15 +837,13 @@ ari_validator ast_ari_validate_channel_hangup_request_fn(void); * A channel initiated a media hold. * * \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_channel_hold(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_channel_hold(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_channel_hold_fn(void); @@ -939,15 +853,13 @@ ari_validator ast_ari_validate_channel_hold_fn(void); * Notification that a channel has left a bridge. * * \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_channel_left_bridge(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_channel_left_bridge(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_channel_left_bridge_fn(void); @@ -957,15 +869,13 @@ ari_validator ast_ari_validate_channel_left_bridge_fn(void); * Notification of a channel's state change. * * \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_channel_state_change(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_channel_state_change(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_channel_state_change_fn(void); @@ -975,15 +885,13 @@ ari_validator ast_ari_validate_channel_state_change_fn(void); * Talking is no longer detected on the channel. * * \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_channel_talking_finished(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_channel_talking_finished(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_channel_talking_finished_fn(void); @@ -993,15 +901,13 @@ ari_validator ast_ari_validate_channel_talking_finished_fn(void); * Talking was detected on the channel. * * \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_channel_talking_started(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_channel_talking_started(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_channel_talking_started_fn(void); @@ -1011,15 +917,13 @@ ari_validator ast_ari_validate_channel_talking_started_fn(void); * A channel initiated a media unhold. * * \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_channel_unhold(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_channel_unhold(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_channel_unhold_fn(void); @@ -1029,15 +933,13 @@ ari_validator ast_ari_validate_channel_unhold_fn(void); * User-generated event with additional user-defined fields in the 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_channel_userevent(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_channel_userevent(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_channel_userevent_fn(void); @@ -1047,15 +949,13 @@ ari_validator ast_ari_validate_channel_userevent_fn(void); * Channel variable changed. * * \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_channel_varset(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_channel_varset(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_channel_varset_fn(void); @@ -1065,15 +965,13 @@ ari_validator ast_ari_validate_channel_varset_fn(void); * Detailed information about a contact on an endpoint. * * \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_contact_info(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_contact_info(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_contact_info_fn(void); @@ -1083,15 +981,13 @@ ari_validator ast_ari_validate_contact_info_fn(void); * The state of a contact on an endpoint has changed. * * \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_contact_status_change(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_contact_status_change(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_contact_status_change_fn(void); @@ -1101,15 +997,13 @@ ari_validator ast_ari_validate_contact_status_change_fn(void); * Notification that a device state has changed. * * \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_device_state_changed(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_device_state_changed(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_device_state_changed_fn(void); @@ -1119,15 +1013,13 @@ ari_validator ast_ari_validate_device_state_changed_fn(void); * Dialing state has changed. * * \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_dial(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_dial(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_dial_fn(void); @@ -1137,15 +1029,13 @@ ari_validator ast_ari_validate_dial_fn(void); * Endpoint state changed. * * \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_endpoint_state_change(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_endpoint_state_change(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_endpoint_state_change_fn(void); @@ -1155,15 +1045,13 @@ ari_validator ast_ari_validate_endpoint_state_change_fn(void); * Base type for asynchronous events from Asterisk. * * \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_event(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_event(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_event_fn(void); @@ -1173,15 +1061,13 @@ ari_validator ast_ari_validate_event_fn(void); * Base type for errors and events * * \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_message(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_message(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_message_fn(void); @@ -1191,15 +1077,13 @@ ari_validator ast_ari_validate_message_fn(void); * Error event sent when required params are missing. * * \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_missing_params(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_missing_params(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_missing_params_fn(void); @@ -1209,15 +1093,13 @@ ari_validator ast_ari_validate_missing_params_fn(void); * Detailed information about a remote peer that communicates with Asterisk. * * \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_peer(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_peer(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_peer_fn(void); @@ -1227,15 +1109,13 @@ ari_validator ast_ari_validate_peer_fn(void); * The state of a peer associated with an endpoint has changed. * * \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_peer_status_change(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_peer_status_change(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_peer_status_change_fn(void); @@ -1245,15 +1125,13 @@ ari_validator ast_ari_validate_peer_status_change_fn(void); * Event showing the continuation of a media playback operation from one media URI to the next in the list. * * \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_playback_continuing(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_playback_continuing(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_playback_continuing_fn(void); @@ -1263,15 +1141,13 @@ ari_validator ast_ari_validate_playback_continuing_fn(void); * Event showing the completion of a media playback operation. * * \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_playback_finished(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_playback_finished(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_playback_finished_fn(void); @@ -1281,15 +1157,13 @@ ari_validator ast_ari_validate_playback_finished_fn(void); * Event showing the start of a media playback operation. * * \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_playback_started(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_playback_started(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_playback_started_fn(void); @@ -1299,15 +1173,13 @@ ari_validator ast_ari_validate_playback_started_fn(void); * Event showing failure of a recording operation. * * \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_recording_failed(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_recording_failed(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_recording_failed_fn(void); @@ -1317,15 +1189,13 @@ ari_validator ast_ari_validate_recording_failed_fn(void); * Event showing the completion of a recording operation. * * \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_recording_finished(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_recording_finished(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_recording_finished_fn(void); @@ -1335,15 +1205,13 @@ ari_validator ast_ari_validate_recording_finished_fn(void); * Event showing the start of a recording operation. * * \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_recording_started(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_recording_started(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_recording_started_fn(void); @@ -1353,15 +1221,13 @@ ari_validator ast_ari_validate_recording_started_fn(void); * Notification that a channel has left a Stasis application. * * \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_stasis_end(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_stasis_end(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_stasis_end_fn(void); @@ -1371,15 +1237,13 @@ ari_validator ast_ari_validate_stasis_end_fn(void); * Notification that a channel has entered a Stasis application. * * \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_stasis_start(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_stasis_start(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_stasis_start_fn(void); @@ -1389,15 +1253,13 @@ ari_validator ast_ari_validate_stasis_start_fn(void); * A text message was received from an endpoint. * * \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_text_message_received(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_text_message_received(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_text_message_received_fn(void); @@ -1407,15 +1269,13 @@ ari_validator ast_ari_validate_text_message_received_fn(void); * Details of a Stasis application * * \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_application(struct ast_json *json); /*! * \brief Function pointer to ast_ari_validate_application(). - * - * See \ref ast_ari_model_validators.h for more details. */ ari_validator ast_ari_validate_application_fn(void); diff --git a/res/ari/resource_bridges.c b/res/ari/resource_bridges.c index 3efc662bd4..20faef397b 100644 --- a/res/ari/resource_bridges.c +++ b/res/ari/resource_bridges.c @@ -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, @@ -342,6 +342,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 @@ -351,7 +352,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, @@ -513,6 +514,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 diff --git a/res/ari/resource_channels.c b/res/ari/resource_channels.c index 4854dca59e..674748014e 100644 --- a/res/ari/resource_channels.c +++ b/res/ari/resource_channels.c @@ -113,7 +113,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, @@ -1722,8 +1722,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) { diff --git a/res/ari/resource_events.h b/res/ari/resource_events.h index 8c03af4b0e..7b07415908 100644 --- a/res/ari/resource_events.h +++ b/res/ari/resource_events.h @@ -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); diff --git a/res/res_ari.c b/res/res_ari.c index 828942068d..e8d1fee722 100644 --- a/res/res_ari.c +++ b/res/res_ari.c @@ -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) diff --git a/res/res_ari_applications.c b/res/res_ari_applications.c index 4d1443ec36..a7f20149bf 100644 --- a/res/res_ari_applications.c +++ b/res/res_ari_applications.c @@ -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( diff --git a/res/res_ari_asterisk.c b/res/res_ari_asterisk.c index a077548c0d..0434c4aad7 100644 --- a/res/res_ari_asterisk.c +++ b/res/res_ari_asterisk.c @@ -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( diff --git a/res/res_ari_bridges.c b/res/res_ari_bridges.c index 7ef0f684a5..c6fe90b59e 100644 --- a/res/res_ari_bridges.c +++ b/res/res_ari_bridges.c @@ -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( @@ -445,9 +455,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( @@ -605,9 +617,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( @@ -718,9 +732,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( @@ -781,9 +797,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( @@ -852,9 +870,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( @@ -921,9 +941,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( @@ -1034,9 +1056,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( @@ -1207,9 +1231,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( @@ -1367,9 +1393,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( diff --git a/res/res_ari_channels.c b/res/res_ari_channels.c index e45ba546c1..9256c88fda 100644 --- a/res/res_ari_channels.c +++ b/res/res_ari_channels.c @@ -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( @@ -604,9 +614,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( @@ -698,9 +710,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( @@ -794,9 +808,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( @@ -879,9 +895,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( @@ -951,9 +969,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( @@ -1011,9 +1031,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( @@ -1071,9 +1093,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( @@ -1160,9 +1184,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( @@ -1256,9 +1282,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( @@ -1339,9 +1367,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( @@ -1409,9 +1439,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( @@ -1469,9 +1501,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( @@ -1542,9 +1576,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( @@ -1612,9 +1648,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( @@ -1672,9 +1710,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( @@ -1732,9 +1772,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( @@ -1846,9 +1888,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( @@ -2020,9 +2064,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( @@ -2181,9 +2227,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( @@ -2283,9 +2331,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( @@ -2370,9 +2420,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( @@ -2472,9 +2524,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( @@ -2578,9 +2632,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( @@ -2676,9 +2732,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( @@ -2748,9 +2806,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( @@ -2847,9 +2907,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( diff --git a/res/res_ari_device_states.c b/res/res_ari_device_states.c index 12962b68a6..841908cdc7 100644 --- a/res/res_ari_device_states.c +++ b/res/res_ari_device_states.c @@ -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( diff --git a/res/res_ari_endpoints.c b/res/res_ari_endpoints.c index 947da71e2c..d41096c0e2 100644 --- a/res/res_ari_endpoints.c +++ b/res/res_ari_endpoints.c @@ -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( diff --git a/res/res_ari_events.c b/res/res_ari_events.c index 1c4655f827..8684112631 100644 --- a/res/res_ari_events.c +++ b/res/res_ari_events.c @@ -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( diff --git a/res/res_ari_mailboxes.c b/res/res_ari_mailboxes.c index e25a7bc3db..dcb560621f 100644 --- a/res/res_ari_mailboxes.c +++ b/res/res_ari_mailboxes.c @@ -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( diff --git a/res/res_ari_playbacks.c b/res/res_ari_playbacks.c index 5fbfcf1654..d31a3553db 100644 --- a/res/res_ari_playbacks.c +++ b/res/res_ari_playbacks.c @@ -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( diff --git a/res/res_ari_recordings.c b/res/res_ari_recordings.c index 6487f3e15a..43c67ae0fb 100644 --- a/res/res_ari_recordings.c +++ b/res/res_ari_recordings.c @@ -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( diff --git a/res/res_ari_sounds.c b/res/res_ari_sounds.c index b9c9bdfac3..b332aaea93 100644 --- a/res/res_ari_sounds.c +++ b/res/res_ari_sounds.c @@ -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( diff --git a/rest-api-templates/ari_model_validators.h.mustache b/rest-api-templates/ari_model_validators.h.mustache index 0b055db5af..c65713863c 100644 --- a/rest-api-templates/ari_model_validators.h.mustache +++ b/rest-api-templates/ari_model_validators.h.mustache @@ -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}} diff --git a/rest-api-templates/ari_resource.h.mustache b/rest-api-templates/ari_resource.h.mustache index c1d880d30c..6cdd96ef6c 100644 --- a/rest-api-templates/ari_resource.h.mustache +++ b/rest-api-templates/ari_resource.h.mustache @@ -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); diff --git a/rest-api-templates/res_ari_resource.c.mustache b/rest-api-templates/res_ari_resource.c.mustache index e320f19fc3..6301330fe8 100644 --- a/rest-api-templates/res_ari_resource.c.mustache +++ b/rest-api-templates/res_ari_resource.c.mustache @@ -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(