mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-20 12:20:12 +00:00
ed48377994
Created a data model and implemented functionality for an ARI device state
resource. The following operations have been added that allow a user to
manipulate an ARI controlled device:
Create/Change the state of an ARI controlled device
PUT /deviceStates/{deviceName}&{deviceState}
Retrieve all ARI controlled devices
GET /deviceStates
Retrieve the current state of a device
GET /deviceStates/{deviceName}
Destroy a device-state controlled by ARI
DELETE /deviceStates/{deviceName}
The ARI controlled device must begin with 'Stasis:'. An example controlled
device name would be Stasis:Example. A 'DeviceStateChanged' event has also
been added so that an application can subscribe and receive device change
events. Any device state, ARI controlled or not, can be subscribed to.
While adding the event, the underlying subscription control mechanism was
refactored so that all current and future resource subscriptions would be
the same. Each event resource must now register itself in order to be able
to properly handle [un]subscribes.
(issue ASTERISK-22838)
Reported by: Matt Jordan
Review: https://reviewboard.asterisk.org/r/3025/
........
Merged revisions 403134 from http://svn.asterisk.org/svn/asterisk/branches/12
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@403135 65c4cc65-6c06-0410-ace0-fbb531ad65f3
173 lines
4.3 KiB
JSON
173 lines
4.3 KiB
JSON
{
|
|
"_copyright": "Copyright (C) 2013, Digium, Inc.",
|
|
"_author": "David M. Lee, II <dlee@digium.com>",
|
|
"_svn_revision": "$Revision$",
|
|
"apiVersion": "0.0.1",
|
|
"swaggerVersion": "1.1",
|
|
"basePath": "http://localhost:8088/stasis",
|
|
"resourcePath": "/api-docs/applications.{format}",
|
|
"apis": [
|
|
{
|
|
"path": "/applications",
|
|
"description": "Stasis applications",
|
|
"operations": [
|
|
{
|
|
"httpMethod": "GET",
|
|
"summary": "List all applications.",
|
|
"nickname": "list",
|
|
"responseClass": "List[Application]"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/applications/{applicationName}",
|
|
"description": "Stasis application",
|
|
"operations": [
|
|
{
|
|
"httpMethod": "GET",
|
|
"summary": "Get details of an application.",
|
|
"nickname": "get",
|
|
"responseClass": "Application",
|
|
"parameters": [
|
|
{
|
|
"name": "applicationName",
|
|
"description": "Application's name",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"allowMultiple": false,
|
|
"dataType": "string"
|
|
}
|
|
],
|
|
"errorResponses": [
|
|
{
|
|
"code": 404,
|
|
"reason": "Application does not exist."
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/applications/{applicationName}/subscription",
|
|
"description": "Stasis application",
|
|
"operations": [
|
|
{
|
|
"httpMethod": "POST",
|
|
"summary": "Subscribe an application to a event source.",
|
|
"notes": "Returns the state of the application after the subscriptions have changed",
|
|
"nickname": "subscribe",
|
|
"responseClass": "Application",
|
|
"parameters": [
|
|
{
|
|
"name": "applicationName",
|
|
"description": "Application's name",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"allowMultiple": false,
|
|
"dataType": "string"
|
|
},
|
|
{
|
|
"name": "eventSource",
|
|
"description": "URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource}, deviceState:{deviceName}",
|
|
"paramType": "query",
|
|
"required": true,
|
|
"allowMultiple": true,
|
|
"dataType": "string"
|
|
}
|
|
],
|
|
"errorResponses": [
|
|
{
|
|
"code": 400,
|
|
"reason": "Missing parameter."
|
|
},
|
|
{
|
|
"code": 404,
|
|
"reason": "Application does not exist."
|
|
},
|
|
{
|
|
"code": 422,
|
|
"reason": "Event source does not exist."
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"httpMethod": "DELETE",
|
|
"summary": "Unsubscribe an application from an event source.",
|
|
"notes": "Returns the state of the application after the subscriptions have changed",
|
|
"nickname": "unsubscribe",
|
|
"responseClass": "Application",
|
|
"parameters": [
|
|
{
|
|
"name": "applicationName",
|
|
"description": "Application's name",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"allowMultiple": false,
|
|
"dataType": "string"
|
|
},
|
|
{
|
|
"name": "eventSource",
|
|
"description": "URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource}, device_state:{deviceName}",
|
|
"paramType": "query",
|
|
"required": true,
|
|
"allowMultiple": true,
|
|
"dataType": "string"
|
|
}
|
|
],
|
|
"errorResponses": [
|
|
{
|
|
"code": 400,
|
|
"reason": "Missing parameter; event source scheme not recognized."
|
|
},
|
|
{
|
|
"code": 404,
|
|
"reason": "Application does not exist."
|
|
},
|
|
{
|
|
"code": 409,
|
|
"reason": "Application not subscribed to event source."
|
|
},
|
|
{
|
|
"code": 422,
|
|
"reason": "Event source does not exist."
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"models": {
|
|
"Application": {
|
|
"id": "Application",
|
|
"description": "Details of a Stasis application",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Name of this application",
|
|
"required": true
|
|
},
|
|
"channel_ids": {
|
|
"type": "List[string]",
|
|
"description": "Id's for channels subscribed to.",
|
|
"required": true
|
|
},
|
|
"bridge_ids": {
|
|
"type": "List[string]",
|
|
"description": "Id's for bridges subscribed to.",
|
|
"required": true
|
|
},
|
|
"endpoint_ids": {
|
|
"type": "List[string]",
|
|
"description": "{tech}/{resource} for endpoints subscribed to.",
|
|
"required": true
|
|
},
|
|
"device_names": {
|
|
"type": "List[string]",
|
|
"description": "Names of the devices subscribed to.",
|
|
"required": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|