asterisk/rest-api/api-docs/endpoints.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 endoints.",
					"nickname": "getEndpoints",
					"responseClass": "List[Endpoint]"
				}
			]
		},
		{
			"path": "/endpoints/{tech}",
			"description": "Asterisk endpoints",
			"operations": [
				{
					"httpMethod": "GET",
					"summary": "List available endoints for a given endpoint technology.",
					"nickname": "getEndpointsByTech",
					"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": "getEndpoint",
					"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": "A snapshot of an endpoint. Unlike 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
				}
			}
		}
	}
}