diff options
| author | Matthew Jordan <mjordan@digium.com> | 2015-01-27 17:21:03 +0000 |
|---|---|---|
| committer | Matthew Jordan <mjordan@digium.com> | 2015-01-27 17:21:03 +0000 |
| commit | fb8a2e039978b264737aa7a4ed08f9af4c329f47 (patch) | |
| tree | fe2b256c707be4347f78c384468ffbf1aacba8dd /rest-api/api-docs/bridges.json | |
| parent | aa8fd7d1b9dcbcc207cbcc333df850b3e8e0be54 (diff) | |
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
Diffstat (limited to 'rest-api/api-docs/bridges.json')
| -rw-r--r-- | rest-api/api-docs/bridges.json | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/rest-api/api-docs/bridges.json b/rest-api/api-docs/bridges.json index 21708c839..4f7f72400 100644 --- a/rest-api/api-docs/bridges.json +++ b/rest-api/api-docs/bridges.json @@ -60,7 +60,7 @@ "httpMethod": "POST", "summary": "Create a new bridge or updates an existing one.", "notes": "This bridge persists until it has been shut down, or Asterisk has been shut down.", - "nickname": "create_or_update_with_id", + "nickname": "createWithId", "responseClass": "Bridge", "parameters": [ { @@ -398,7 +398,7 @@ { "httpMethod": "POST", "summary": "Start playback of media on a bridge.", - "notes": "The media URI may be any of a number of URI's. Currently sound: and recording: URI's are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)", + "notes": "The media URI may be any of a number of URI's. Currently sound:, recording:, number:, digits:, characters:, and tone: URI's are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)", "nickname": "playWithId", "responseClass": "Playback", "parameters": [ |