mirror of
https://github.com/asterisk/asterisk.git
synced 2025-08-16 11:14:52 +00:00
3d5ae0b5e1
This commit adds the ability to make ARI REST requests over the same websocket used to receive events. For full details on how to use the new capability, visit... https://docs.asterisk.org/Configuration/Interfaces/Asterisk-REST-Interface-ARI/ARI-REST-over-WebSocket/ Changes: * Added utilities to http.c: * ast_get_http_method_from_string(). * ast_http_parse_post_form(). * Added utilities to json.c: * ast_json_nvp_array_to_ast_variables(). * ast_variables_to_json_nvp_array(). * Added definitions for new events to carry REST responses. * Created res/ari/ari_websocket_requests.c to house the new request handlers. * Moved non-event specific code out of res/ari/resource_events.c into res/ari/ari_websockets.c * Refactored res/res_ari.c to move non-http code out of ast_ari_callback() (which is http specific) and into ast_ari_invoke() so it can be shared between both the http and websocket transports. UpgradeNote: This commit adds the ability to make ARI REST requests over the same websocket used to receive events. See https://docs.asterisk.org/Configuration/Interfaces/Asterisk-REST-Interface-ARI/ARI-REST-over-WebSocket/
104 lines
2.7 KiB
Plaintext
104 lines
2.7 KiB
Plaintext
{{#api_declaration}}
|
|
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* {{{copyright}}}
|
|
*
|
|
* {{{author}}}
|
|
*
|
|
* See http://www.asterisk.org for more information about
|
|
* the Asterisk project. Please do not directly contact
|
|
* any of the maintainers of this project for assistance;
|
|
* the project provides a web site, mailing lists and IRC
|
|
* channels for your use.
|
|
*
|
|
* This program is free software, distributed under the terms of
|
|
* the GNU General Public License Version 2. See the LICENSE file
|
|
* at the top of the source tree.
|
|
*/
|
|
|
|
/*! \file
|
|
*
|
|
* \brief Generated file - declares stubs to be implemented in
|
|
* res/ari/resource_{{name}}.c
|
|
*
|
|
* {{{description}}}
|
|
*
|
|
* \author {{{author}}}
|
|
*/
|
|
|
|
/*
|
|
{{> do-not-edit}}
|
|
* This file is generated by a mustache template. Please see the original
|
|
* template in rest-api-templates/ari_resource.h.mustache
|
|
*/
|
|
|
|
#ifndef _ASTERISK_RESOURCE_{{name_caps}}_H
|
|
#define _ASTERISK_RESOURCE_{{name_caps}}_H
|
|
|
|
#include "asterisk/ari.h"
|
|
|
|
{{#apis}}
|
|
{{#operations}}
|
|
/*! Argument struct for ast_ari_{{c_name}}_{{c_nickname}}() */
|
|
struct ast_ari_{{c_name}}_{{c_nickname}}_args {
|
|
{{#parameters}}
|
|
{{#description}}
|
|
{{/description}}
|
|
{{^allow_multiple}}
|
|
{{#description}}
|
|
/*! {{{description}}} */
|
|
{{/description}}
|
|
{{c_data_type}}{{c_space}}{{c_name}};
|
|
{{/allow_multiple}}
|
|
{{#allow_multiple}}
|
|
/*! Array of {{{description}}} */
|
|
{{c_data_type}}{{c_space}}*{{c_name}};
|
|
/*! Length of {{c_name}} array. */
|
|
size_t {{c_name}}_count;
|
|
/*! Parsing context for {{c_name}}. */
|
|
char *{{c_name}}_parse;
|
|
{{/allow_multiple}}
|
|
{{/parameters}}
|
|
};
|
|
{{#is_req}}
|
|
{{#parse_body}}
|
|
/*!
|
|
* \brief Body parsing function for {{path}}.
|
|
* \param body The JSON body from which to parse parameters.
|
|
* \param[out] args The args structure to parse into.
|
|
* \retval zero on success
|
|
* \retval non-zero on failure
|
|
*/
|
|
int ast_ari_{{c_name}}_{{c_nickname}}_parse_body(
|
|
struct ast_json *body,
|
|
struct ast_ari_{{c_name}}_{{c_nickname}}_args *args);
|
|
|
|
{{/parse_body}}
|
|
/*!
|
|
* \brief {{{summary}}}
|
|
{{#notes}}
|
|
*
|
|
* {{{notes}}}
|
|
{{/notes}}
|
|
*
|
|
{{#is_binary_response}}
|
|
* \param ser TCP/TLS session instance
|
|
{{/is_binary_response}}
|
|
* \param headers HTTP headers
|
|
* \param args Swagger parameters
|
|
* \param[out] response HTTP response
|
|
*/
|
|
{{^is_binary_response}}
|
|
void ast_ari_{{c_name}}_{{c_nickname}}(struct ast_variable *headers, struct ast_ari_{{c_name}}_{{c_nickname}}_args *args, struct ast_ari_response *response);
|
|
{{/is_binary_response}}
|
|
{{#is_binary_response}}
|
|
void ast_ari_{{c_name}}_{{c_nickname}}(struct ast_tcptls_session_instance *ser, struct ast_variable *headers, struct ast_ari_{{c_name}}_{{c_nickname}}_args *args, struct ast_ari_response *response);
|
|
{{/is_binary_response}}
|
|
{{/is_req}}
|
|
{{/operations}}
|
|
{{/apis}}
|
|
|
|
#endif /* _ASTERISK_RESOURCE_{{name_caps}}_H */
|
|
{{/api_declaration}}
|