ari: Add events for playback and recording.
[asterisk/asterisk.git] / rest-api / api-docs / endpoints.json
index d3d77d8..fb66357 100644 (file)
@@ -13,8 +13,8 @@
                        "operations": [
                                {
                                        "httpMethod": "GET",
-                                       "summary": "List all endoints.",
-                                       "nickname": "getEndpoints",
+                                       "summary": "List all endpoints.",
+                                       "nickname": "list",
                                        "responseClass": "List[Endpoint]"
                                }
                        ]
@@ -26,7 +26,7 @@
                                {
                                        "httpMethod": "GET",
                                        "summary": "List available endoints for a given endpoint technology.",
-                                       "nickname": "getEndpointsByTech",
+                                       "nickname": "listByTech",
                                        "responseClass": "List[Endpoint]",
                                        "parameters": [
                                                {
                                                        "paramType": "path",
                                                        "dataType": "string"
                                                }
+                                       ],
+                                       "errorResponses": [
+                                               {
+                                                       "code": 404,
+                                                       "reason": "Endpoints not found"
+                                               }
                                        ]
                                }
                        ]
@@ -46,7 +52,7 @@
                                {
                                        "httpMethod": "GET",
                                        "summary": "Details for an endpoint.",
-                                       "nickname": "getEndpoint",
+                                       "nickname": "get",
                                        "responseClass": "Endpoint",
                                        "parameters": [
                                                {
                                                        "paramType": "path",
                                                        "dataType": "string"
                                                }
+                                       ],
+                                       "errorResponses": [
+                                               {
+                                                       "code": 404,
+                                                       "reason": "Endpoints not found"
+                                               }
                                        ]
                                }
                        ]
@@ -69,7 +81,7 @@
        "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.",
+                       "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",
                                        "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
                                }
                        }
                }