asterisk/rest-api
Matthew Jordan fb8a2e0399 ARI: Improve wiki documentation
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
2015-01-27 17:21:03 +00:00
..
api-docs ARI: Improve wiki documentation 2015-01-27 17:21:03 +00:00
README.txt This patch adds a RESTful HTTP interface to Asterisk. 2013-04-22 14:58:53 +00:00
resources.json Add the ability to continue and originate using priority labels. 2015-01-07 18:54:06 +00:00

<!-- Written in -*- Markdown -*- -->

This directory contains the specification for the Asterisk RESTful
API. The API is documented using Swagger[1]. This is used to not only
generate executable documentation pages for the API, but also to
generate a lot of the boilerplate necessary for implementing the API
with Asterisk's HTTP server.

 [1]: http://swagger.wordnik.com/