asterisk

History

George Joseph 24c077f1fb docs: Enable since/version handling for XML, CLI and ARI documentation * Added the "since" element to the XML configObject and configOption elements in appdocsxml.dtd. * Added the "Since" section to the following CLI output: ``` config show help <module> <object> config show help <module> <object> <option> core show application <app> core show function <func> manager show command <command> manager show event <event> agi show commands topic <topic> ``` * Refactored the commands above to output their sections in the same order: Synopsis, Since, Description, Syntax, Arguments, SeeAlso * Refactored the commands above so they all use the same pattern for writing the output to the CLI. * Fixed several memory leaks caused by failure to free temporary output buffers. * Added a "since" array to the mustache template for the top-level resources (Channel, Endpoint, etc.) and to the paths/methods underneath them. These will be added to the generated markdown if present. Example: ``` "resourcePath": "/api-docs/channels.{format}", "requiresModules": [ "res_stasis_answer", "res_stasis_playback", "res_stasis_recording", "res_stasis_snoop" ], "since": [ "18.0.0", "21.0.0" ], "apis": [ { "path": "/channels", "description": "Active channels", "operations": [ { "httpMethod": "GET", "since": [ "18.6.0", "21.8.0" ], "summary": "List all active channels in Asterisk.", "nickname": "list", "responseClass": "List[Channel]" }, ``` NOTE: No versioning information is actually added in this commit. Those will be added separately and instructions for adding and maintaining them will be published on the documentation site at a later date. (cherry picked from commit `3e28ddce78`)		3 months ago
..
README.txt	…
api.wiki.mustache	docs: Enable since/version handling for XML, CLI and ARI documentation	3 months ago
ari.make.mustache	Build System: Create Makefile macro MOD_ADD_SOURCE.	10 years ago
ari_model_validators.c.mustache	Remove ASTERISK_REGISTER_FILE.	9 years ago
ari_model_validators.h.mustache	res_ari: Fix for Doxygen.	3 years ago
ari_resource.c.mustache	Remove ASTERISK_REGISTER_FILE.	9 years ago
ari_resource.h.mustache	res_ari: Fix for Doxygen.	3 years ago
asterisk_processor.py	ari-stubs: Avoid 'is' as comparism with an literal.	3 years ago
body_parsing.mustache	ARI: Support channel variables in originate	11 years ago
do-not-edit.mustache	…
make_ari_stubs.py	ari-stubs: Fix broken documentation anchors	2 years ago
models.wiki.mustache	ari-stubs: Fix broken documentation anchors	2 years ago
odict.py	…
param_cleanup.mustache	ARI - implement allowMultiple for parameters	12 years ago
param_parsing.mustache	ari: Implement 'debug all' and request/response logging	8 years ago
res_ari_resource.c.mustache	res_ari: Fix for Doxygen.	3 years ago
rest_handler.mustache	ari: User better nicknames for ARI operations	12 years ago
swagger_model.py	docs: Enable since/version handling for XML, CLI and ARI documentation	3 months ago
transform.py	rest-api-templates: Spelling fixes	3 years ago

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/