kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-06 12:36:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

ARI: Improve wiki documentation

Browse Source 
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


git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/13@431145 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Matthew Jordan
2015-01-27 17:20:23 +00:00
parent 1a17693789
commit 7f9b28b0c6
9 changed files with 68 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
rest-api/api-docs/bridges.json
View File

@@ -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": [

26
rest-api/api-docs/channels.json
View File

@@ -34,7 +34,7 @@
},
{
"name": "extension",
"description": "The extension to dial after the endpoint answers",
"description": "The extension to dial after the endpoint answers. Mutually exclusive with 'app'.",
"paramType": "query",
"required": false,
"allowMultiple": false,
@@ -42,7 +42,7 @@
},
{
"name": "context",
"description": "The context to dial after the endpoint answers. If omitted, uses 'default'",
"description": "The context to dial after the endpoint answers. If omitted, uses 'default'. Mutually exclusive with 'app'.",
"paramType": "query",
"required": false,
"allowMultiple": false,
@@ -50,7 +50,7 @@
},
{
"name": "priority",
"description": "The priority to dial after the endpoint answers. If omitted, uses 1",
"description": "The priority to dial after the endpoint answers. If omitted, uses 1. Mutually exclusive with 'app'.",
"paramType": "query",
"required": false,
"allowMultiple": false,
@@ -58,7 +58,7 @@
},
{
"name": "label",
"description": "The label to dial after the endpoint answers. Will supersede 'priority' if provided.",
"description": "The label to dial after the endpoint answers. Will supersede 'priority' if provided. Mutually exclusive with 'app'.",
"paramType": "query",
"required": false,
"allowMultiple": false,
@@ -66,7 +66,7 @@
},
{
"name": "app",
"description": "The application that is subscribed to the originated channel, and passed to the Stasis application.",
"description": "The application that is subscribed to the originated channel. When the channel is answered, it will be passed to this Stasis application. Mutually exclusive with 'context', 'extension', 'priority', and 'label'.",
"paramType": "query",
"required": false,
"allowMultiple": false,
@@ -74,7 +74,7 @@
},
{
"name": "appArgs",
"description": "The application arguments to pass to the Stasis application.",
"description": "The application arguments to pass to the Stasis application provided by 'app'. Mutually exclusive with 'context', 'extension', 'priority', and 'label'.",
"paramType": "query",
"required": false,
"allowMultiple": false,
@@ -190,7 +190,7 @@
},
{
"name": "extension",
"description": "The extension to dial after the endpoint answers",
"description": "The extension to dial after the endpoint answers. Mutually exclusive with 'app'.",
"paramType": "query",
"required": false,
"allowMultiple": false,
@@ -198,7 +198,7 @@
},
{
"name": "context",
"description": "The context to dial after the endpoint answers. If omitted, uses 'default'",
"description": "The context to dial after the endpoint answers. If omitted, uses 'default'. Mutually exclusive with 'app'.",
"paramType": "query",
"required": false,
"allowMultiple": false,
@@ -206,7 +206,7 @@
},
{
"name": "priority",
"description": "The priority to dial after the endpoint answers. If omitted, uses 1",
"description": "The priority to dial after the endpoint answers. If omitted, uses 1. Mutually exclusive with 'app'.",
"paramType": "query",
"required": false,
"allowMultiple": false,
@@ -214,7 +214,7 @@
},
{
"name": "label",
"description": "The label to dial after the endpoint answers. Will supersede priority, if provided",
"description": "The label to dial after the endpoint answers. Will supersede 'priority' if provided. Mutually exclusive with 'app'.",
"paramType": "query",
"required": false,
"allowMultiple": false,
@@ -222,7 +222,7 @@
},
{
"name": "app",
"description": "The application that is subscribed to the originated channel, and passed to the Stasis application.",
"description": "The application that is subscribed to the originated channel. When the channel is answered, it will be passed to this Stasis application. Mutually exclusive with 'context', 'extension', 'priority', and 'label'.",
"paramType": "query",
"required": false,
"allowMultiple": false,
@@ -230,7 +230,7 @@
},
{
"name": "appArgs",
"description": "The application arguments to pass to the Stasis application.",
"description": "The application arguments to pass to the Stasis application provided by 'app'. Mutually exclusive with 'context', 'extension', 'priority', and 'label'.",
"paramType": "query",
"required": false,
"allowMultiple": false,
@@ -922,7 +922,7 @@
{
"httpMethod": "POST",
"summary": "Start playback of media and specify the playbackId.",
"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": [