summaryrefslogtreecommitdiff
path: root/rest-api/api-docs/endpoints.json
blob: 43b8453d76ae0099bdc4910ae2c26a849d682524 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
{
	"_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 available endoints.",
					"nickname": "getEndpoints",
					"responseClass": "List[Endpoint]",
					"parameters": [
						{
							"name": "withType",
							"description": "Filter endpoints by type (sip,iax2,dhadi,...)",
							"paramType": "query",
							"required": false,
							"allowMultiple": true,
							"dataType": "string"
						}
					]
				}
			]
		},
		{
			"path": "/endpoints/{endpointId}",
			"description": "Single endpoint",
			"operations": [
				{
					"httpMethod": "GET",
					"summary": "Details for an endpoint.",
					"nickname": "getEndpoint",
					"responseClass": "Endpoint",
					"parameters": [
						{
							"name": "endpointId",
							"description": "ID of the endpoint",
							"paramType": "path",
							"dataType": "string"
						}
					]
				}
			]
		}
	],
	"models": {
		"Endpoint": {
			"id": "Endpoint",
			"properties": {
				"technology": {
					"type": "string",
					"required": true
				},
				"name": {
					"type": "string",
					"required": true
				}
			}
		}
	}
}