This patch adds a RESTful HTTP interface to Asterisk.
[asterisk/asterisk.git] / rest-api / api-docs / endpoints.json
1 {
2         "_copyright": "Copyright (C) 2012 - 2013, Digium, Inc.",
3         "_author": "David M. Lee, II <dlee@digium.com>",
4         "_svn_revision": "$Revision$",
5         "apiVersion": "0.0.1",
6         "swaggerVersion": "1.1",
7         "basePath": "http://localhost:8088/stasis",
8         "resourcePath": "/api-docs/endpoints.{format}",
9         "apis": [
10                 {
11                         "path": "/endpoints",
12                         "description": "Asterisk endpoints",
13                         "operations": [
14                                 {
15                                         "httpMethod": "GET",
16                                         "summary": "List available endoints.",
17                                         "nickname": "getEndpoints",
18                                         "responseClass": "List[Endpoint]",
19                                         "parameters": [
20                                                 {
21                                                         "name": "withType",
22                                                         "description": "Filter endpoints by type (sip,iax2,dhadi,...)",
23                                                         "paramType": "query",
24                                                         "required": false,
25                                                         "allowMultiple": true,
26                                                         "dataType": "string"
27                                                 }
28                                         ]
29                                 }
30                         ]
31                 },
32                 {
33                         "path": "/endpoints/{endpointId}",
34                         "description": "Single endpoint",
35                         "operations": [
36                                 {
37                                         "httpMethod": "GET",
38                                         "summary": "Details for an endpoint.",
39                                         "nickname": "getEndpoint",
40                                         "responseClass": "Endpoint",
41                                         "parameters": [
42                                                 {
43                                                         "name": "endpointId",
44                                                         "description": "ID of the endpoint",
45                                                         "paramType": "path",
46                                                         "dataType": "string"
47                                                 }
48                                         ]
49                                 }
50                         ]
51                 }
52         ],
53         "models": {
54                 "Endpoint": {
55                         "id": "Endpoint",
56                         "properties": {
57                                 "technology": {
58                                         "type": "string",
59                                         "required": true
60                                 },
61                                 "name": {
62                                         "type": "string",
63                                         "required": true
64                                 }
65                         }
66                 }
67         }
68 }