diff options
| author | Benjamin Ford <bford@digium.com> | 2015-07-13 10:54:51 -0500 |
|---|---|---|
| committer | Benjamin Keith Ford <bford@digium.com> | 2015-07-13 14:29:27 -0500 |
| commit | 6a764db3700b31847138fcbfc7d811b96f99aca2 (patch) | |
| tree | 95b8e5a4488fd4b59ab0ffa1d420b8a533196544 /rest-api | |
| parent | 66b57b10f65bee8600c01a0fc03fb491edb7ad76 (diff) | |
ARI: Added new functionality to get information on a single module.
An http request can be sent to retrieve information on a single
module, including the resource name, description, use count, status,
and support level.
The command "curl -v -u user:pass -X GET '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
* Information on a single module can now be retrieved
ASTERISK-25173
Change-Id: Ibce5a94e70ecdf4e90329cf0ba66c33a62d37463
Diffstat (limited to 'rest-api')
| -rw-r--r-- | rest-api/api-docs/asterisk.json | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/rest-api/api-docs/asterisk.json b/rest-api/api-docs/asterisk.json index ade5938c9..76c834e45 100644 --- a/rest-api/api-docs/asterisk.json +++ b/rest-api/api-docs/asterisk.json @@ -51,6 +51,38 @@ ] }, { + "path": "/asterisk/modules/{moduleName}", + "description": "Asterisk module", + "operations": [ + { + "httpMethod": "GET", + "summary": "Get Asterisk module information.", + "nickname": "getModule", + "responseClass": "Module", + "parameters": [ + { + "name": "moduleName", + "description": "Module's name", + "paramType": "path", + "required": true, + "allowMultiple": false, + "dataType": "string" + } + ], + "errorResponses": [ + { + "code": 404, + "reason": "Module could not be found in running modules." + }, + { + "code": 409, + "reason": "Module information could not be retrieved." + } + ] + } + ] + }, + { "path": "/asterisk/variable", "description": "Global variables", "operations": [ |