From aa7f9e55f26bb721e84a3943eef45d5ad959334b Mon Sep 17 00:00:00 2001
From: Kinsey Moore <kmoore@digium.com>
Date: Tue, 29 Oct 2013 12:51:57 +0000
Subject: [PATCH] ARI: Remove channels/{channelId}/dial
This removes the /ari/channels/{channelId}/dial URI since it is
redundant, overly complex, is likely to become more externally complex
over time, and is too high-level compared with other ARI operations.
See the following for further information:
http://lists.digium.com/pipermail/asterisk-app-dev/2013-October/000002.html
(closes issue ASTERISK-22784)
Reported by: Matt Jordan
Review: https://reviewboard.asterisk.org/r/2968/
........
Merged revisions 402152 from http://svn.asterisk.org/svn/asterisk/branches/12
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@402153 65c4cc65-6c06-0410-ace0-fbb531ad65f3
---
res/ari/resource_channels.c | 18 -------
res/ari/resource_channels.h | 21 --------
res/res_ari_channels.c | 86 +--------------------------------
rest-api/api-docs/channels.json | 65 -------------------------
4 files changed, 2 insertions(+), 188 deletions(-)
diff --git a/res/ari/resource_channels.c b/res/ari/resource_channels.c
index f1a9217afb..a00b295329 100644
--- a/res/ari/resource_channels.c
+++ b/res/ari/resource_channels.c
@@ -34,7 +34,6 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/file.h"
#include "asterisk/pbx.h"
-#include "asterisk/dial.h"
#include "asterisk/bridge.h"
#include "asterisk/callerid.h"
#include "asterisk/stasis_app.h"
@@ -81,23 +80,6 @@ static struct stasis_app_control *find_control(
return control;
}
-void ast_ari_dial(struct ast_variable *headers, struct ast_dial_args *args, struct ast_ari_response *response)
-{
- struct stasis_app_control *control;
-
- control = find_control(response, args->channel_id);
- if (control == NULL) {
- return;
- }
-
- if (stasis_app_control_dial(control, args->endpoint, args->extension, args->context, args->timeout)) {
- ast_ari_response_alloc_failed(response);
- return;
- }
-
- ast_ari_response_no_content(response);
-}
-
void ast_ari_continue_in_dialplan(
struct ast_variable *headers,
struct ast_continue_in_dialplan_args *args,
diff --git a/res/ari/resource_channels.h b/res/ari/resource_channels.h
index a65bb981bc..d7d1dd0dbd 100644
--- a/res/ari/resource_channels.h
+++ b/res/ari/resource_channels.h
@@ -105,27 +105,6 @@ struct ast_delete_channel_args {
* \param[out] response HTTP response
*/
void ast_ari_delete_channel(struct ast_variable *headers, struct ast_delete_channel_args *args, struct ast_ari_response *response);
-/*! \brief Argument struct for ast_ari_dial() */
-struct ast_dial_args {
- /*! \brief Channel's id */
- const char *channel_id;
- /*! \brief Endpoint to call. If not specified, dial is routed via dialplan */
- const char *endpoint;
- /*! \brief Extension to dial */
- const char *extension;
- /*! \brief When routing via dialplan, the context use. If omitted, uses 'default' */
- const char *context;
- /*! \brief Timeout (in seconds) before giving up dialing, or -1 for no timeout. */
- int timeout;
-};
-/*!
- * \brief Create a new channel (originate) and bridge to this channel.
- *
- * \param headers HTTP headers
- * \param args Swagger parameters
- * \param[out] response HTTP response
- */
-void ast_ari_dial(struct ast_variable *headers, struct ast_dial_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_continue_in_dialplan() */
struct ast_continue_in_dialplan_args {
/*! \brief Channel's id */
diff --git a/res/res_ari_channels.c b/res/res_ari_channels.c
index 79aa88492e..82ec3b6bc3 100644
--- a/res/res_ari_channels.c
+++ b/res/res_ari_channels.c
@@ -289,79 +289,6 @@ static void ast_ari_delete_channel_cb(
}
#endif /* AST_DEVMODE */
-fin: __attribute__((unused))
- return;
-}
-/*!
- * \brief Parameter parsing callback for /channels/{channelId}/dial.
- * \param get_params GET parameters in the HTTP request.
- * \param path_vars Path variables extracted from the request.
- * \param headers HTTP headers.
- * \param[out] response Response to the HTTP request.
- */
-static void ast_ari_dial_cb(
- struct ast_variable *get_params, struct ast_variable *path_vars,
- struct ast_variable *headers, struct ast_ari_response *response)
-{
- struct ast_dial_args args = {};
- struct ast_variable *i;
-#if defined(AST_DEVMODE)
- int is_valid;
- int code;
-#endif /* AST_DEVMODE */
-
- for (i = get_params; i; i = i->next) {
- if (strcmp(i->name, "endpoint") == 0) {
- args.endpoint = (i->value);
- } else
- if (strcmp(i->name, "extension") == 0) {
- args.extension = (i->value);
- } else
- if (strcmp(i->name, "context") == 0) {
- args.context = (i->value);
- } else
- if (strcmp(i->name, "timeout") == 0) {
- args.timeout = atoi(i->value);
- } else
- {}
- }
- for (i = path_vars; i; i = i->next) {
- if (strcmp(i->name, "channelId") == 0) {
- args.channel_id = (i->value);
- } else
- {}
- }
- ast_ari_dial(headers, &args, response);
-#if defined(AST_DEVMODE)
- code = response->response_code;
-
- switch (code) {
- case 0: /* Implementation is still a stub, or the code wasn't set */
- is_valid = response->message == NULL;
- break;
- case 500: /* Internal Server Error */
- case 501: /* Not Implemented */
- case 404: /* Channel not found */
- case 409: /* Channel not in a Stasis application */
- is_valid = 1;
- break;
- default:
- if (200 <= code && code <= 299) {
- is_valid = ast_ari_validate_dialed(
- response->message);
- } else {
- ast_log(LOG_ERROR, "Invalid error response %d for /channels/{channelId}/dial\n", code);
- is_valid = 0;
- }
- }
-
- if (!is_valid) {
- ast_log(LOG_ERROR, "Response validation failed for /channels/{channelId}/dial\n");
- ast_ari_response_error(response, 500,
- "Internal Server Error", "Response validation failed");
- }
-#endif /* AST_DEVMODE */
-
fin: __attribute__((unused))
return;
}
@@ -1150,15 +1077,6 @@ fin: __attribute__((unused))
return;
}
-/*! \brief REST handler for /api-docs/channels.{format} */
-static struct stasis_rest_handlers channels_channelId_dial = {
- .path_segment = "dial",
- .callbacks = {
- [AST_HTTP_POST] = ast_ari_dial_cb,
- },
- .num_children = 0,
- .children = { }
-};
/*! \brief REST handler for /api-docs/channels.{format} */
static struct stasis_rest_handlers channels_channelId_continue = {
.path_segment = "continue",
@@ -1251,8 +1169,8 @@ static struct stasis_rest_handlers channels_channelId = {
[AST_HTTP_GET] = ast_ari_get_channel_cb,
[AST_HTTP_DELETE] = ast_ari_delete_channel_cb,
},
- .num_children = 10,
- .children = { &channels_channelId_dial,&channels_channelId_continue,&channels_channelId_answer,&channels_channelId_mute,&channels_channelId_unmute,&channels_channelId_hold,&channels_channelId_moh,&channels_channelId_play,&channels_channelId_record,&channels_channelId_variable, }
+ .num_children = 9,
+ .children = { &channels_channelId_continue,&channels_channelId_answer,&channels_channelId_mute,&channels_channelId_unmute,&channels_channelId_hold,&channels_channelId_moh,&channels_channelId_play,&channels_channelId_record,&channels_channelId_variable, }
};
/*! \brief REST handler for /api-docs/channels.{format} */
static struct stasis_rest_handlers channels = {
diff --git a/rest-api/api-docs/channels.json b/rest-api/api-docs/channels.json
index 39dc4e376a..7d22c41fb6 100644
--- a/rest-api/api-docs/channels.json
+++ b/rest-api/api-docs/channels.json
@@ -149,71 +149,6 @@
}
]
},
- {
- "path": "/channels/{channelId}/dial",
- "description": "Create a new channel (originate) and bridge to this channel",
- "operations": [
- {
- "httpMethod": "POST",
- "summary": "Create a new channel (originate) and bridge to this channel.",
- "nickname": "dial",
- "responseClass": "Dialed",
- "parameters": [
- {
- "name": "channelId",
- "description": "Channel's id",
- "paramType": "path",
- "required": true,
- "allowMultiple": false,
- "dataType": "string"
- },
- {
- "name": "endpoint",
- "description": "Endpoint to call. If not specified, dial is routed via dialplan",
- "paramType": "query",
- "required": false,
- "allowMultiple": false,
- "dataType": "string"
- },
- {
- "name": "extension",
- "description": "Extension to dial",
- "paramType": "query",
- "required": false,
- "allowMultiple": false,
- "dataType": "string"
- },
- {
- "name": "context",
- "description": "When routing via dialplan, the context use. If omitted, uses 'default'",
- "paramType": "query",
- "required": false,
- "allowMultiple": false,
- "dataType": "string"
- },
- {
- "name": "timeout",
- "description": "Timeout (in seconds) before giving up dialing, or -1 for no timeout.",
- "paramType": "query",
- "required": false,
- "allowMultiple": false,
- "dataType": "int",
- "defaultValue": 30
- }
- ],
- "errorResponses": [
- {
- "code": 404,
- "reason": "Channel not found"
- },
- {
- "code": 409,
- "reason": "Channel not in a Stasis application"
- }
- ]
- }
- ]
- },
{
"path": "/channels/{channelId}/continue",
"description": "Exit application; continue execution in the dialplan",
--
GitLab