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 /res/ari/resource_events.h | |
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 'res/ari/resource_events.h')
-rw-r--r-- | res/ari/resource_events.h | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/res/ari/resource_events.h b/res/ari/resource_events.h index 021a59636..646cf9bfc 100644 --- a/res/ari/resource_events.h +++ b/res/ari/resource_events.h @@ -68,7 +68,7 @@ struct ast_ari_events_user_event_args { 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; }; /*! |