asterisk/rest-api-templates
Corey Farrell 679fa5fb34 Add missing OPTIONAL_API and ARI dependences.
I've audited all modules that include any header which includes
asterisk/optional_api.h.  All modules which use OPTIONAL_API now declare
those dependencies in AST_MODULE_INFO using requires or optional_modules
as appropriate.

In addition ARI dependency declarations have been reworked.  Instead of
declaring additional required modules in res/ari/resource_*.c we now add
them to an optional array "requiresModules" in api-docs for each module.
This allows the AST_MODULE_INFO dependencies to include those missing
modules.

Change-Id: Ia0c70571f5566784f63605e78e1ceccb4f79c606
2018-01-22 12:16:58 -05:00
..
README.txt This patch adds a RESTful HTTP interface to Asterisk. 2013-04-22 14:58:53 +00:00
api.wiki.mustache ari: Add documentation that path parameters are case-sensitive 2016-08-16 12:27:14 -05:00
ari.make.mustache Build System: Create Makefile macro MOD_ADD_SOURCE. 2015-04-14 12:53:03 -04:00
ari_model_validators.c.mustache Remove ASTERISK_REGISTER_FILE. 2016-10-27 09:53:55 -04:00
ari_model_validators.h.mustache Remove as much trailing whitespace as possible. 2017-12-22 09:23:22 -05:00
ari_resource.c.mustache Remove ASTERISK_REGISTER_FILE. 2016-10-27 09:53:55 -04:00
ari_resource.h.mustache ARI: Add the ability to download the media associated with a stored recording 2016-05-20 09:06:12 -05:00
asterisk_processor.py Fixes to various issues reported by pyflakes 2016-12-21 11:02:20 +02:00
body_parsing.mustache ARI: Support channel variables in originate 2014-01-21 14:27:21 +00:00
do-not-edit.mustache This patch adds a RESTful HTTP interface to Asterisk. 2013-04-22 14:58:53 +00:00
make_ari_stubs.py Update make_ari_stubs in master to make the version 16 2017-07-21 10:41:20 -06:00
models.wiki.mustache The Swagger 1.2 specification for type extension ended up being 2013-10-24 20:48:17 +00:00
odict.py This patch adds a RESTful HTTP interface to Asterisk. 2013-04-22 14:58:53 +00:00
param_cleanup.mustache ARI - implement allowMultiple for parameters 2013-08-02 14:36:32 +00:00
param_parsing.mustache ari: Implement 'debug all' and request/response logging 2017-01-23 10:25:58 -07:00
res_ari_resource.c.mustache Add missing OPTIONAL_API and ARI dependences. 2018-01-22 12:16:58 -05:00
rest_handler.mustache ari: User better nicknames for ARI operations 2013-11-07 21:10:31 +00:00
swagger_model.py Add missing OPTIONAL_API and ARI dependences. 2018-01-22 12:16:58 -05:00
transform.py Fixes to various issues reported by pyflakes 2016-12-21 11:02:20 +02:00

README.txt

This directory contains templates and template processing code for generating
HTTP bindings for the RESTful API's.

The RESTful API's are declared using [Swagger][swagger]. While Swagger provides
a [code generating toolkit][swagger-codegen], it requires Java to run, which
would be an unusual dependency to require for Asterisk developers.

This code generator is similar, but written in Python. Templates are processed
by using [pystache][pystache], which is a fairly simply Python implementation of
[mustache][mustache].

 [swagger]: https://github.com/wordnik/swagger-core/wiki
 [swagger-codegen]: https://github.com/wordnik/swagger-codegen
 [pystache]: https://github.com/defunkt/pystache
 [mustache]: http://mustache.github.io/