From f64f1c2772909779758cb8cf7f3a328e0ec5ffd1 Mon Sep 17 00:00:00 2001
From: Benjamin Ford <bford@digium.com>
Date: Tue, 14 Jul 2015 08:55:14 -0500
Subject: ARI: Added new functionality to unload a single module.

An http request can be sent to unload an Asterisk module. If the
module can not be unloaded or is already unloaded, an error response
will be returned.

The command "curl -v -u user:pass -X DELETE 'http://localhost:8088
/ari/asterisk/modules/{moduleName}'" (or something similar, depending
on configuration) can be run in the terminal to access this new
functionality.

For more information, see:
https://wiki.asterisk.org/wiki.display/~bford/Asterisk+ARI+Resource

* Added new ARI functionality
* Asterisk modules can be unloaded through http requests

ASTERISK-25173

Change-Id: I535a95f5676deb02651522761ecbdc0b00b5ac57
---
 rest-api/api-docs/asterisk.json | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

(limited to 'rest-api')

diff --git a/rest-api/api-docs/asterisk.json b/rest-api/api-docs/asterisk.json
index dcbfb2c7b..28badce80 100644
--- a/rest-api/api-docs/asterisk.json
+++ b/rest-api/api-docs/asterisk.json
@@ -101,6 +101,32 @@
 							"reason": "Module could not be loaded."
 						}
 					]
+				},
+				{
+					"httpMethod": "DELETE",
+					"summary": "Unload an Asterisk module.",
+					"nickname": "unloadModule",
+					"responseClass": "void",
+					"parameters": [
+						{
+							"name": "moduleName",
+							"description": "Module's name",
+							"paramType": "path",
+							"required": true,
+							"allowMultiple": false,
+							"dataType": "string"
+						}
+					],
+					"errorResponses": [
+						{
+							"code": 404,
+							"reason": "Module not found in running modules."
+						},
+						{
+							"code": 409,
+							"reason": "Module could not be unloaded."
+						}
+					]
 				}
 			]
 		},
-- 
cgit v1.2.3