kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-12 15:45:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

ARI: Improve wiki documentation

Browse Source 
This patch improves the documentation of ARI on the wiki. Specifically, it
addresses the following:
* Allowed values and allowed ranges weren't documented. This was particularly
  frustrating, as Asterisk would reject query parameters with disallowed values
  - but we didn't tell anyone what the allowed values were.
* The /play/id operation on /channels and /bridges failed to document all of
  the added media resource types.
* Documentation for creating a channel into a Stasis application failed to
  note when it occurred, and that creating a channel into Stasis conflicts with
  creating a channel into the dialplan.
* Some other minor tweaks in the mustache templates, including italicizing the
  parameter type, putting the default value on its own sub-bullet, and some
  other nicities.

Review: https://reviewboard.asterisk.org/r/4351


git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/13@431145 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Matthew Jordan
2015-01-27 17:20:23 +00:00
parent 1a17693789
commit 7f9b28b0c6
9 changed files with 68 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
res/res_ari_bridges.c
View File

@@ -206,9 +206,9 @@ static void ast_ari_bridges_create_cb(
fin: __attribute__((unused))
return;
}
int ast_ari_bridges_create_or_update_with_id_parse_body(
int ast_ari_bridges_create_with_id_parse_body(
struct ast_json *body,
struct ast_ari_bridges_create_or_update_with_id_args *args)
struct ast_ari_bridges_create_with_id_args *args)
{
struct ast_json *field;
/* Parse query parameters out of it */
@@ -230,12 +230,12 @@ int ast_ari_bridges_create_or_update_with_id_parse_body(
* \param headers HTTP headers.
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_bridges_create_or_update_with_id_cb(
static void ast_ari_bridges_create_with_id_cb(
struct ast_tcptls_session_instance *ser,
struct ast_variable *get_params, struct ast_variable *path_vars,
struct ast_variable *headers, struct ast_ari_response *response)
{
struct ast_ari_bridges_create_or_update_with_id_args args = {};
struct ast_ari_bridges_create_with_id_args args = {};
struct ast_variable *i;
RAII_VAR(struct ast_json *, body, NULL, ast_json_unref);
#if defined(AST_DEVMODE)
@@ -273,11 +273,11 @@ static void ast_ari_bridges_create_or_update_with_id_cb(
goto fin;
}
}
if (ast_ari_bridges_create_or_update_with_id_parse_body(body, &args)) {
if (ast_ari_bridges_create_with_id_parse_body(body, &args)) {
ast_ari_response_alloc_failed(response);
goto fin;
}
ast_ari_bridges_create_or_update_with_id(headers, &args, response);
ast_ari_bridges_create_with_id(headers, &args, response);
#if defined(AST_DEVMODE)
code = response->response_code;
@@ -1378,7 +1378,7 @@ static struct stasis_rest_handlers bridges_bridgeId = {
.path_segment = "bridgeId",
.is_wildcard = 1,
.callbacks = {
[AST_HTTP_POST] = ast_ari_bridges_create_or_update_with_id_cb,
[AST_HTTP_POST] = ast_ari_bridges_create_with_id_cb,
[AST_HTTP_GET] = ast_ari_bridges_get_cb,
[AST_HTTP_DELETE] = ast_ari_bridges_destroy_cb,
},