This patch improves the documentation of ARI on the wiki. Specifically, it addresses the following: * Allowed values and allowed ranges weren't documented. This was particularly frustrating, as Asterisk would reject query parameters with disallowed values - but we didn't tell anyone what the allowed values were. * The /play/id operation on /channels and /bridges failed to document all of the added media resource types. * Documentation for creating a channel into a Stasis application failed to note when it occurred, and that creating a channel into Stasis conflicts with creating a channel into the dialplan. * Some other minor tweaks in the mustache templates, including italicizing the parameter type, putting the default value on its own sub-bullet, and some other nicities. Review: https://reviewboard.asterisk.org/r/4351 ........ Merged revisions 431145 from http://svn.asterisk.org/svn/asterisk/branches/13 git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@431148 65c4cc65-6c06-0410-ace0-fbb531ad65f3 |
||
---|---|---|
.. | ||
api.wiki.mustache | ||
ari.make.mustache | ||
ari_model_validators.c.mustache | ||
ari_model_validators.h.mustache | ||
ari_resource.c.mustache | ||
ari_resource.h.mustache | ||
asterisk_processor.py | ||
body_parsing.mustache | ||
do-not-edit.mustache | ||
make_ari_stubs.py | ||
models.wiki.mustache | ||
odict.py | ||
param_cleanup.mustache | ||
param_parsing.mustache | ||
README.txt | ||
res_ari_resource.c.mustache | ||
rest_handler.mustache | ||
swagger_model.py | ||
transform.py |
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/