kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-05 20:20:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

ARI: Improvements to body parameters documentation

Browse Source 
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
This commit is contained in:
Sam Galarneau
2014-07-03 16:14:39 +00:00
parent 5db3f38d5a
commit aa370d6105
4 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
res/ari/resource_channels.h
View File

@@ -68,7 +68,7 @@ struct ast_ari_channels_originate_args {
const char *caller_id; const char *caller_id;
/*! Timeout (in seconds) before giving up dialing, or -1 for no timeout. */ /*! Timeout (in seconds) before giving up dialing, or -1 for no timeout. */
int 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; struct ast_json *variables;
/*! The unique id to assign the channel on creation. */ /*! The unique id to assign the channel on creation. */
const char *channel_id; const char *channel_id;
@@ -129,7 +129,7 @@ struct ast_ari_channels_originate_with_id_args {
const char *caller_id; const char *caller_id;
/*! Timeout (in seconds) before giving up dialing, or -1 for no timeout. */ /*! Timeout (in seconds) before giving up dialing, or -1 for no timeout. */
int 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; struct ast_json *variables;
/*! The unique id to assign the second channel when using local channels. */ /*! The unique id to assign the second channel when using local channels. */
const char *other_channel_id; const char *other_channel_id;

2
res/ari/resource_events.h
View File

@@ -68,7 +68,7 @@ struct ast_ari_events_user_event_args {
size_t source_count; size_t source_count;
/*! Parsing context for source. */ /*! Parsing context for source. */
char *source_parse; 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; struct ast_json *variables;
}; };
/*! /*!

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

@@ -91,7 +91,7 @@
}, },
{ {
"name": "variables", "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", "paramType": "body",
"required": false, "required": false,
"dataType": "containers", "dataType": "containers",
@@ -231,7 +231,7 @@
}, },
{ {
"name": "variables", "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", "paramType": "body",
"required": false, "required": false,
"dataType": "containers", "dataType": "containers",

2
rest-api/api-docs/events.json
View File

@@ -67,7 +67,7 @@
}, },
{ {
"name": "variables", "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", "paramType": "body",
"required": false, "required": false,
"allowMultiple": false, "allowMultiple": false,