forked from nrwiersma/ConfigManager
-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathopenapi.yml
227 lines (212 loc) · 5.23 KB
/
openapi.yml
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
openapi: '3.0.2'
info:
title: WiFi Config API
version: '1.0'
contact:
name: Andrey Ovcharov
email: [email protected]
url: https://en.ovcharov.me/
servers:
- url: http://localhost:3000/
description: Local mock server
components:
schemas:
WiFiStatus:
type: object
properties:
mode:
type: string
enum:
- sta
- ap
connected:
type: boolean
WiFiAccessPoint:
type: object
properties:
ssid:
type: string
channel:
type: integer
rssi:
type: integer
open:
type: boolean
SettingsGroup:
type: object
properties:
name:
type: string
label:
type: string
description:
type: string
params:
type: array
items:
$ref: '#/components/schemas/SettingsValue'
SettingsValue:
type: object
properties:
name:
type: string
label:
type: string
description:
type: string
type:
type: string
enum:
- string
- int
- bool
paths:
/:
get:
description: Root URL for the API
responses:
'200':
description: OK
/wifi:
get:
description: Get current WiFi Status
responses:
'200':
description: Return status of WiFi connection
content:
"application/json":
schema:
$ref: '#/components/schemas/WiFiStatus'
example:
mode: sta
connected: false
/wifi/scan:
get:
description: Scan for available WiFi Access Points
responses:
'200':
description: List of available WiFi Access Points
content:
"application/json":
schema:
type: array
items:
$ref: '#/components/schemas/WiFiAccessPoint'
example:
- ssid: Access Point 1
channel: 1
rssi: -58
open: false
- ssid: Access Point 2
channel: 2
rssi: -99
open: true
/wifi/connect:
post:
description: Connect to the Access Point
requestBody:
content:
'application/json':
schema:
type: object
properties:
ssid:
type: string
password:
type: string
example:
ssid: Access Point 1
password: qwerty123
responses:
'204':
description: OK
'400':
description: Error
/wifi/disconnect:
post:
description: Disconnect from the Access Point
responses:
'204':
description: OK
'400':
description: Error
/settings:
options:
description: Get settings schema
responses:
'200':
description: Settings schema
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/SettingsGroup'
example:
- name: co2
label: CO2 Levels
params:
- name: warning
label: Warning
description: Warning CO2 level in ppm
type: int
- name: danger
label: Danger
description: Dangerous CO2 level in ppm
type: int
- name: mqtt
label: MQTT Settings
description: Connect the device to the MQTT Server
params:
- name: enabled
label: Enabled
type: bool
- name: server
label: Server
type: string
- name: port
label: Port
type: int
get:
description: Get settings values
responses:
'200':
description: Get current values
content:
'application/json':
schema:
type: object
example:
co2:
warning: 800
danger: 1400
mqtt:
enabled: false
server: 'mqtt.server.com'
port: 1234
post:
description: Update settings
requestBody:
content:
'application/json':
schema:
type: object
example:
co2:
warning: 800
danger: 1400
mqtt:
enabled: false
server: 'mqtt.server.com'
port: 1234
responses:
'204':
description: Ok
'400':
description: Error
/reboot:
post:
description: Reboot the device
responses:
'204':
description: OK