mirror of
https://github.com/asterisk/asterisk.git
synced 2025-11-11 12:28:27 +00:00
2f92695c22
While working on building client libraries from the Swagger API, I
noticed a problem with the nicknames.
channel.deleteChannel()
channel.answerChannel()
channel.muteChannel()
Etc. We put the object name in the nickname (since we were generating C
code), but it makes OO generators redundant.
This patch makes the nicknames more OO friendly. This resulted in a lot
of name changing within the res_ari_*.so modules, but not much else.
There were a couple of other fixed I made in the process.
* When reversible operations (POST /hold, POST /unhold) were made more
RESTful (POST /hold, DELETE /unhold), the path for the second operation
was left in the API declaration. This worked, but really the two
operations should have been on the same API.
* The POST /unmute operation had still not been REST-ified.
Review: https://reviewboard.asterisk.org/r/2940/
git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/12@402528 65c4cc65-6c06-0410-ace0-fbb531ad65f3
106 lines
2.5 KiB
JSON
106 lines
2.5 KiB
JSON
{
|
|
"_copyright": "Copyright (C) 2012 - 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/endpoints.{format}",
|
|
"apis": [
|
|
{
|
|
"path": "/endpoints",
|
|
"description": "Asterisk endpoints",
|
|
"operations": [
|
|
{
|
|
"httpMethod": "GET",
|
|
"summary": "List all endpoints.",
|
|
"nickname": "list",
|
|
"responseClass": "List[Endpoint]"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/endpoints/{tech}",
|
|
"description": "Asterisk endpoints",
|
|
"operations": [
|
|
{
|
|
"httpMethod": "GET",
|
|
"summary": "List available endoints for a given endpoint technology.",
|
|
"nickname": "listByTech",
|
|
"responseClass": "List[Endpoint]",
|
|
"parameters": [
|
|
{
|
|
"name": "tech",
|
|
"description": "Technology of the endpoints (sip,iax2,...)",
|
|
"paramType": "path",
|
|
"dataType": "string"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/endpoints/{tech}/{resource}",
|
|
"description": "Single endpoint",
|
|
"operations": [
|
|
{
|
|
"httpMethod": "GET",
|
|
"summary": "Details for an endpoint.",
|
|
"nickname": "get",
|
|
"responseClass": "Endpoint",
|
|
"parameters": [
|
|
{
|
|
"name": "tech",
|
|
"description": "Technology of the endpoint",
|
|
"paramType": "path",
|
|
"dataType": "string"
|
|
},
|
|
{
|
|
"name": "resource",
|
|
"description": "ID of the endpoint",
|
|
"paramType": "path",
|
|
"dataType": "string"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"models": {
|
|
"Endpoint": {
|
|
"id": "Endpoint",
|
|
"description": "An external device that may offer/accept calls to/from Asterisk.\n\nUnlike most resources, which have a single unique identifier, an endpoint is uniquely identified by the technology/resource pair.",
|
|
"properties": {
|
|
"technology": {
|
|
"type": "string",
|
|
"description": "Technology of the endpoint",
|
|
"required": true
|
|
},
|
|
"resource": {
|
|
"type": "string",
|
|
"description": "Identifier of the endpoint, specific to the given technology.",
|
|
"required": true
|
|
},
|
|
"state": {
|
|
"type": "string",
|
|
"description": "Endpoint's state",
|
|
"required": false,
|
|
"allowableValues": {
|
|
"valueType": "LIST",
|
|
"values": [
|
|
"unknown",
|
|
"offline",
|
|
"online"
|
|
]
|
|
}
|
|
},
|
|
"channel_ids": {
|
|
"type": "List[string]",
|
|
"description": "Id's of channels associated with this endpoint",
|
|
"required": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|