[svn-commits] sgalarneau: trunk r417879 - in /trunk: ./ res/ari/ rest-api/api-docs/
SVN commits to the Digium repositories
svn-commits at lists.digium.com
Thu Jul 3 11:14:44 CDT 2014
Author: sgalarneau
Date: Thu Jul 3 11:14:39 2014
New Revision: 417879
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=417879
Log:
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
Modified:
trunk/ (props changed)
trunk/res/ari/resource_channels.h
trunk/res/ari/resource_events.h
trunk/rest-api/api-docs/channels.json
trunk/rest-api/api-docs/events.json
Propchange: trunk/
------------------------------------------------------------------------------
Binary property 'branch-12-merged' - no diff available.
Modified: trunk/res/ari/resource_channels.h
URL: http://svnview.digium.com/svn/asterisk/trunk/res/ari/resource_channels.h?view=diff&rev=417879&r1=417878&r2=417879
==============================================================================
--- trunk/res/ari/resource_channels.h (original)
+++ trunk/res/ari/resource_channels.h Thu Jul 3 11:14:39 2014
@@ -68,7 +68,7 @@
const char *caller_id;
/*! Timeout (in seconds) before giving up dialing, or -1 for no timeout. */
int timeout;
- /*! 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' } } */
+ /*! 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" } } */
struct ast_json *variables;
/*! The unique id to assign the channel on creation. */
const char *channel_id;
@@ -129,7 +129,7 @@
const char *caller_id;
/*! Timeout (in seconds) before giving up dialing, or -1 for no timeout. */
int timeout;
- /*! 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' } } */
+ /*! 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" } } */
struct ast_json *variables;
/*! The unique id to assign the second channel when using local channels. */
const char *other_channel_id;
Modified: trunk/res/ari/resource_events.h
URL: http://svnview.digium.com/svn/asterisk/trunk/res/ari/resource_events.h?view=diff&rev=417879&r1=417878&r2=417879
==============================================================================
--- trunk/res/ari/resource_events.h (original)
+++ trunk/res/ari/resource_events.h Thu Jul 3 11:14:39 2014
@@ -68,7 +68,7 @@
size_t source_count;
/*! Parsing context for source. */
char *source_parse;
- /*! custom key/value pairs added to the user event */
+ /*! The "variables" key in the body object holds custom key/value pairs to add to the user event. Ex. { "variables": { "key": "value" } } */
struct ast_json *variables;
};
/*!
Modified: trunk/rest-api/api-docs/channels.json
URL: http://svnview.digium.com/svn/asterisk/trunk/rest-api/api-docs/channels.json?view=diff&rev=417879&r1=417878&r2=417879
==============================================================================
--- trunk/rest-api/api-docs/channels.json (original)
+++ trunk/rest-api/api-docs/channels.json Thu Jul 3 11:14:39 2014
@@ -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",
Modified: trunk/rest-api/api-docs/events.json
URL: http://svnview.digium.com/svn/asterisk/trunk/rest-api/api-docs/events.json?view=diff&rev=417879&r1=417878&r2=417879
==============================================================================
--- trunk/rest-api/api-docs/events.json (original)
+++ trunk/rest-api/api-docs/events.json Thu Jul 3 11:14:39 2014
@@ -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,
More information about the svn-commits
mailing list