From 1b7760a8aac5f43ed72849598ada769207c51c13 Mon Sep 17 00:00:00 2001
From: Benjamin Ford <bford@digium.com>
Date: Fri, 26 Jun 2015 10:57:15 -0500
Subject: ARI: Added new functionality to get all module information.

An http request can be sent to retrieve a list of all existing modules,
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" (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 modules can now be retrieved

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

(limited to 'rest-api')

diff --git a/rest-api/api-docs/asterisk.json b/rest-api/api-docs/asterisk.json
index 263bfd614..ade5938c9 100644
--- a/rest-api/api-docs/asterisk.json
+++ b/rest-api/api-docs/asterisk.json
@@ -38,6 +38,18 @@
 				}
 			]
 		},
+		{
+			"path": "/asterisk/modules",
+			"description": "Asterisk modules",
+			"operations": [
+				{
+					"httpMethod": "GET",
+					"summary": "List Asterisk modules.",
+					"nickname": "listModules",
+					"responseClass": "List[Module]"
+				}
+			]
+		},
 		{
 			"path": "/asterisk/variable",
 			"description": "Global variables",
@@ -244,6 +256,37 @@
 				}
 			}
 		},
+		"Module": {
+			"id": "Module",
+			"description": "Details of an Asterisk module",
+			"properties": {
+				"name": {
+					"type": "string",
+					"description": "The name of this module",
+					"required": true
+				},
+				"description": {
+					"type": "string",
+					"description": "The description of this module",
+					"required": true
+				},
+				"use_count": {
+					"type": "int",
+					"description": "The number of times this module is being used",
+					"required": true
+				},
+				"status": {
+					"type": "string",
+					"description": "The running status of this module",
+					"required": true
+				},
+				"support_level": {
+					"type": "string",
+					"description": "The support state of this module",
+					"required": true
+				}
+			}
+		},
 		"Variable": {
 			"id": "Variable",
 			"description": "The value of a channel variable",
-- 
cgit v1.2.3