forked from alekras/erl.mqtt.server
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mqtt_rest_v2.yaml
158 lines (158 loc) · 3.95 KB
/
mqtt_rest_v2.yaml
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
swagger: "2.0"
info:
title: "MQTT server API"
description: >-
This is a RESTful API of MQTT server management. The API manages user database of MQTT server.
See for details https://github.com/alekras/erl.mqtt.server
contact:
email: krasnop@bellsouth.net
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
version: "1.0.1"
externalDocs:
description: Find out more about Erlang MQTT server
url: https://github.com/alekras/erl.mqtt.server
host: "lucky3p.com:8880"
basePath: "/rest"
tags:
- name: "user"
description: "Manage user database"
externalDocs:
description: "Find out more"
url: "http://lucky3p.com"
schemes:
- "http"
- "https"
paths:
/user/{user_name}:
parameters:
- name: "user_name"
in: "path"
description: "User name"
required: true
type: "string"
get:
tags:
- "user"
summary: "Get user's information"
description: "Returns a user's password in md5 format and list of roles"
operationId: "getUserInfo"
produces:
- "application/json"
responses:
"200":
description: "Successful operation"
schema:
$ref: "#/definitions/User"
"400":
description: "Invalid user name supplied"
"404":
description: "User not found"
post:
tags:
- "user"
summary: "Add a new user to the database"
operationId: "createNewUser"
consumes:
- "application/x-www-form-urlencoded"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "User's password in md5 format and roles"
required: true
schema:
$ref: "#/definitions/User"
responses:
"201":
description: "Successful operation"
"400":
description: "Invalid request"
delete:
tags:
- "user"
summary: "Delete user in the database"
operationId: "deleteUser"
responses:
"200":
description: "Successful operation"
"404":
description: "User not found"
/user/{user_name}/status:
get:
tags:
- "user"
summary: "Get user connection status"
description: "Returns a user connection status"
operationId: "getStatus"
produces:
- "application/json"
parameters:
- name: "user_name"
in: "path"
description: "User name"
required: true
type: "string"
responses:
"200":
description: "Successful operation"
schema:
$ref: "#/definitions/ConnectionStatus"
"400":
description: "Invalid user name supplied"
"404":
description: "User not found"
/user/status:
get:
tags:
- "user"
summary: "Get user connection statuses"
description: "Returns a list of user statuses"
operationId: "getAllStatuses"
consumes:
- "application/x-www-form-urlencoded"
produces:
- "application/json"
parameters:
- in: "query"
name: "users"
description: "List of user names"
required: true
type: array
collectionFormat: csv
uniqueItems: true
items:
type: "string"
responses:
"200":
description: "Successful operation"
schema:
$ref: "#/definitions/ConnectionStatusList"
"400":
description: "Invalid user name supplied"
"404":
description: "User not found"
definitions:
User:
type: object
properties:
password:
type: string
roles:
type: array
items:
type: string
ConnectionStatus:
type: "object"
properties:
id:
type: "string"
status:
type: "string"
enum: [on, off, notFound]
ConnectionStatusList:
type: "array"
items:
$ref: "#/definitions/ConnectionStatus"