diff options
author | Sam Galarneau <sgalarneau@digium.com> | 2014-07-03 16:14:39 +0000 |
---|---|---|
committer | Sam Galarneau <sgalarneau@digium.com> | 2014-07-03 16:14:39 +0000 |
commit | aa370d6105e4d69fc6fc6c72baecfbf5d51534ef (patch) | |
tree | afbaa01f2ec7897e3482823bc7ef89a16bb66a1d /rest-api/api-docs/channels.json | |
parent | 5db3f38d5a8d49e4d07e6342b4557092496d28de (diff) |
ARI: Improvements to body parameters documentation
The variables body parameter under the originate and originate with id
operations of the channel resource showed invalid JSON in its description.
The variables body parameter under the userEvent operation of the event
resource made no mention that the custom key/value pairs should be wrapped
in a variables key in order to be added to the custom user event.
ASTERISK-23975 #close
Review: https://reviewboard.asterisk.org/r/3692/
........
Merged revisions 417878 from http://svn.asterisk.org/svn/asterisk/branches/12
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@417879 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'rest-api/api-docs/channels.json')
-rw-r--r-- | rest-api/api-docs/channels.json | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/rest-api/api-docs/channels.json b/rest-api/api-docs/channels.json index 997c34501..96dbebd7d 100644 --- a/rest-api/api-docs/channels.json +++ b/rest-api/api-docs/channels.json @@ -91,7 +91,7 @@ }, { "name": "variables", - "description": "The 'variables' key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { 'endpoint': 'SIP/Alice', 'variables': { 'CALLERID(name)': 'Alice' } }", + "description": "The \"variables\" key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { \"endpoint\": \"SIP/Alice\", \"variables\": { \"CALLERID(name)\": \"Alice\" } }", "paramType": "body", "required": false, "dataType": "containers", @@ -231,7 +231,7 @@ }, { "name": "variables", - "description": "The 'variables' key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { 'endpoint': 'SIP/Alice', 'variables': { 'CALLERID(name)': 'Alice' } }", + "description": "The \"variables\" key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { \"endpoint\": \"SIP/Alice\", \"variables\": { \"CALLERID(name)\": \"Alice\" } }", "paramType": "body", "required": false, "dataType": "containers", |