[asterisk-dev] [Code Review] 4351: ARI: improve wiki documentation

[Matt Jordan]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviewboard.asterisk.org/r/4351/
-----------------------------------------------------------

(Updated Jan. 27, 2015, 11:20 a.m.)


Status
------

This change has been marked as submitted.


Review request for Asterisk Developers.


Changes
-------

Committed in revision 431145


Repository: Asterisk


Description
-------

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.


Diffs
-----

  /branches/13/rest-api/api-docs/channels.json 430751 
  /branches/13/rest-api/api-docs/bridges.json 430751 
  /branches/13/rest-api-templates/swagger_model.py 430751 
  /branches/13/rest-api-templates/asterisk_processor.py 430751 
  /branches/13/rest-api-templates/api.wiki.mustache 430751 
  /branches/13/res/res_ari_bridges.c 430751 
  /branches/13/res/ari/resource_channels.h 430751 
  /branches/13/res/ari/resource_bridges.h 430751 

Diff: https://reviewboard.asterisk.org/r/4351/diff/


Testing
-------

Pasted the resulting documentation into a test page. It looks nice.


Thanks,

Matt Jordan

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-dev/attachments/20150127/c0f48dfc/attachment-0001.html>