mirror of
				https://github.com/asterisk/asterisk.git
				synced 2025-10-31 02:37:10 +00:00 
			
		
		
		
	This patch adds a RESTful HTTP interface to Asterisk.
The API itself is documented using Swagger, a lightweight mechanism for documenting RESTful API's using JSON. This allows us to use swagger-ui to provide executable documentation for the API, generate client bindings in different languages, and generate a lot of the boilerplate code for implementing the RESTful bindings. The API docs live in the rest-api/ directory. The RESTful bindings are generated from the Swagger API docs using a set of Mustache templates. The code generator is written in Python, and uses Pystache. Pystache has no dependencies, and be installed easily using pip. Code generation code lives in rest-api-templates/. The generated code reduces a lot of boilerplate when it comes to handling HTTP requests. It also helps us have greater consistency in the REST API. (closes issue ASTERISK-20891) Review: https://reviewboard.asterisk.org/r/2376/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@386232 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
		
							
								
								
									
										84
									
								
								res/stasis_http/resource_playback.h
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										84
									
								
								res/stasis_http/resource_playback.h
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,84 @@ | ||||
| /* | ||||
|  * Asterisk -- An open source telephony toolkit. | ||||
|  * | ||||
|  * Copyright (C) 2012 - 2013, Digium, Inc. | ||||
|  * | ||||
|  * David M. Lee, II <dlee@digium.com> | ||||
|  * | ||||
|  * 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/stasis_http/resource_playback.c | ||||
|  * | ||||
|  * Playback control resources | ||||
|  * | ||||
|  * \author David M. Lee, II <dlee@digium.com> | ||||
|  */ | ||||
|  | ||||
| /* | ||||
|  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | ||||
|  * !!!!!                               DO NOT EDIT                        !!!!! | ||||
|  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! | ||||
|  * This file is generated by a mustache template. Please see the original | ||||
|  * template in rest-api-templates/stasis_http_resource.h.mustache | ||||
|  */ | ||||
|  | ||||
| #ifndef _ASTERISK_RESOURCE_PLAYBACK_H | ||||
| #define _ASTERISK_RESOURCE_PLAYBACK_H | ||||
|  | ||||
| #include "asterisk/stasis_http.h" | ||||
|  | ||||
| /*! \brief Argument struct for stasis_http_get_playback() */ | ||||
| struct ast_get_playback_args { | ||||
| 	/*! \brief Playback's id */ | ||||
| 	const char *playback_id; | ||||
| }; | ||||
| /*! | ||||
|  * \brief Get a playback's details. | ||||
|  * | ||||
|  * \param headers HTTP headers | ||||
|  * \param args Swagger parameters | ||||
|  * \param[out] response HTTP response | ||||
|  */ | ||||
| void stasis_http_get_playback(struct ast_variable *headers, struct ast_get_playback_args *args, struct stasis_http_response *response); | ||||
| /*! \brief Argument struct for stasis_http_stop_playback() */ | ||||
| struct ast_stop_playback_args { | ||||
| 	/*! \brief Playback's id */ | ||||
| 	const char *playback_id; | ||||
| }; | ||||
| /*! | ||||
|  * \brief Stop a playback. | ||||
|  * | ||||
|  * \param headers HTTP headers | ||||
|  * \param args Swagger parameters | ||||
|  * \param[out] response HTTP response | ||||
|  */ | ||||
| void stasis_http_stop_playback(struct ast_variable *headers, struct ast_stop_playback_args *args, struct stasis_http_response *response); | ||||
| /*! \brief Argument struct for stasis_http_control_playback() */ | ||||
| struct ast_control_playback_args { | ||||
| 	/*! \brief Playback's id */ | ||||
| 	const char *playback_id; | ||||
| 	/*! \brief Operation to perform on the playback. */ | ||||
| 	const char *operation; | ||||
| }; | ||||
| /*! | ||||
|  * \brief Get a playback's details. | ||||
|  * | ||||
|  * \param headers HTTP headers | ||||
|  * \param args Swagger parameters | ||||
|  * \param[out] response HTTP response | ||||
|  */ | ||||
| void stasis_http_control_playback(struct ast_variable *headers, struct ast_control_playback_args *args, struct stasis_http_response *response); | ||||
|  | ||||
| #endif /* _ASTERISK_RESOURCE_PLAYBACK_H */ | ||||
		Reference in New Issue
	
	Block a user