diff options
| -rw-r--r-- | res/ari/resource_channels.h | 4 | ||||
| -rw-r--r-- | res/ari/resource_events.h | 2 | ||||
| -rw-r--r-- | rest-api/api-docs/channels.json | 4 | ||||
| -rw-r--r-- | rest-api/api-docs/events.json | 2 |
4 files changed, 6 insertions, 6 deletions
diff --git a/res/ari/resource_channels.h b/res/ari/resource_channels.h index 315ec7868..104e1bdb3 100644 --- a/res/ari/resource_channels.h +++ b/res/ari/resource_channels.h @@ -68,7 +68,7 @@ struct ast_ari_channels_originate_args { 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 @@ struct ast_ari_channels_originate_with_id_args { 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; 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; }; /*! 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, |