aboutsummaryrefslogtreecommitdiff
path: root/swagger.json
diff options
context:
space:
mode:
authorAnton Tananaev <anton.tananaev@gmail.com>2017-09-19 22:10:44 +1200
committerGitHub <noreply@github.com>2017-09-19 22:10:44 +1200
commit6a40551d0e1d63fbb68f0401be73a4c64db4ca64 (patch)
tree36e5d835966f0a7d1d5563e24263b87734c86370 /swagger.json
parent561c616418918da4bb1d75c95347e25c23f72f6a (diff)
parent285f6feea43be782edc6233b709d47b146250361 (diff)
downloadtrackermap-server-6a40551d0e1d63fbb68f0401be73a4c64db4ca64.tar.gz
trackermap-server-6a40551d0e1d63fbb68f0401be73a4c64db4ca64.tar.bz2
trackermap-server-6a40551d0e1d63fbb68f0401be73a4c64db4ca64.zip
Merge pull request #3534 from Abyss777/extend_notifications
Implement per device Notifications
Diffstat (limited to 'swagger.json')
-rw-r--r--swagger.json110
1 files changed, 97 insertions, 13 deletions
diff --git a/swagger.json b/swagger.json
index 762ef3525..5f9abb9b8 100644
--- a/swagger.json
+++ b/swagger.json
@@ -627,19 +627,25 @@
}
}
},
- "/users/notifications": {
+ "/notifications": {
"get": {
- "summary": "Fetch a list of Notification types",
- "description": "Without params, it returns a list of the user's enabled Notifications",
+ "summary": "Fetch a list of Notifications",
+ "description": "Without params, it returns a list of Notifications the user has access to",
"parameters": [
{
- "name": "all",
- "in": "query",
- "description": "To fetch a list of all available Notifications",
- "type": "boolean"
+ "$ref": "#/parameters/all"
},
{
"$ref": "#/parameters/userId"
+ },
+ {
+ "$ref": "#/parameters/deviceId"
+ },
+ {
+ "$ref": "#/parameters/groupId"
+ },
+ {
+ "$ref": "#/parameters/refresh"
}
],
"responses": {
@@ -655,16 +661,32 @@
}
},
"post": {
- "summary": "Set or unset a Notification",
+ "summary": "Create a Notification",
"parameters": [
{
- "name": "body",
- "in": "body",
- "required": true,
+ "$ref": "#/parameters/Notification"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
"schema": {
"$ref": "#/definitions/Notification"
}
}
+ }
+ }
+ },
+ "/notifications/{id}": {
+ "put": {
+ "summary": "Update a Notification",
+ "parameters": [
+ {
+ "$ref": "#/parameters/entityId"
+ },
+ {
+ "$ref": "#/parameters/Notification"
+ }
],
"responses": {
"200": {
@@ -674,6 +696,50 @@
}
}
}
+ },
+ "delete": {
+ "summary": "Delete a Notification",
+ "parameters": [
+ {
+ "$ref": "#/parameters/entityId"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ }
+ }
+ }
+ },
+ "/notifications/types": {
+ "get": {
+ "summary": "Fetch a list of available Notification types",
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NotificationType"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/notifications/test": {
+ "post": {
+ "summary": "Send test notification to current user via Email and SMS",
+ "parameters": [],
+ "responses": {
+ "204": {
+ "description": "Successful sending"
+ },
+ "400": {
+ "description": "Could happen if sending has failed"
+ }
+ }
}
},
"/commandtypes": {
@@ -1604,8 +1670,8 @@
"type": {
"type": "string"
},
- "userId": {
- "type": "integer"
+ "always": {
+ "type": "boolean"
},
"web": {
"type": "boolean"
@@ -1613,9 +1679,19 @@
"mail": {
"type": "boolean"
},
+ "sms": {
+ "type": "boolean"
+ },
"attributes": {}
}
},
+ "NotificationType": {
+ "properties": {
+ "type": {
+ "type": "string"
+ }
+ }
+ },
"Event": {
"properties": {
"id": {
@@ -1966,6 +2042,14 @@
"$ref": "#/definitions/Command"
}
},
+ "Notification": {
+ "name": "body",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Notification"
+ }
+ },
"deviceIdArray": {
"name": "deviceId",
"in": "query",