From aa370d6105e4d69fc6fc6c72baecfbf5d51534ef Mon Sep 17 00:00:00 2001 From: Sam Galarneau Date: Thu, 3 Jul 2014 16:14:39 +0000 Subject: 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 --- rest-api/api-docs/channels.json | 4 ++-- rest-api/api-docs/events.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) (limited to 'rest-api') 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", diff --git a/rest-api/api-docs/events.json b/rest-api/api-docs/events.json index a6879e858..3d07e3613 100644 --- a/rest-api/api-docs/events.json +++ b/rest-api/api-docs/events.json @@ -67,7 +67,7 @@ }, { "name": "variables", - "description": "custom key/value pairs added to the user event", + "description": "The \"variables\" key in the body object holds custom key/value pairs to add to the user event. Ex. { \"variables\": { \"key\": \"value\" } }", "paramType": "body", "required": false, "allowMultiple": false, -- cgit v1.2.3