asterisk/rest-api-templates
Kevin Harwell 574128dec6 rest-api-templates/asterisk_processor - replace http line breaks with line feed
Including line breaks (<br>, <br/>, <br />) in certain parts of the rest-api
json definition (e.g. summary, notes) displays them correctly in swagger.
However, when the field gets converted to the wiki format those breaks get
escaped and show up in the text as the actual string literal "<br>" etc...

This patch makes it so when converting to the wiki format it replaces all line
break values (<br>, etc...) with line feeds ('\n').

Change-Id: Ie1c9faa0d1c5d622804cc0a21ce769095b08aa3d
2019-02-25 17:31:57 -06:00
..
README.txt This patch adds a RESTful HTTP interface to Asterisk. 2013-04-22 14:58:53 +00:00
api.wiki.mustache Build System: Enable python3 compatibility. 2018-04-09 10:07:38 -04: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 optional_api: Remove unused nonoptreq fields 2018-09-12 12:34:54 -05:00
ari_resource.c.mustache Remove ASTERISK_REGISTER_FILE. 2016-10-27 09:53:55 -04:00
ari_resource.h.mustache Build System: Enable python3 compatibility. 2018-04-09 10:07:38 -04:00
asterisk_processor.py rest-api-templates/asterisk_processor - replace http line breaks with line feed 2019-02-25 17:31:57 -06: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 UPDATE.txt for 16 and update ARI stubs. 2018-07-18 19:23:02 +00: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 Build System: Enable python3 compatibility. 2018-04-09 10:07:38 -04:00
rest_handler.mustache ari: User better nicknames for ARI operations 2013-11-07 21:10:31 +00:00
swagger_model.py Build System: Enable python3 compatibility. 2018-04-09 10:07:38 -04:00
transform.py Build System: Enable python3 compatibility. 2018-04-09 10:07:38 -04: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/