Skip to content

Commit cfb3920

Browse files
authored
Merge pull request #18 from pvizeli/update_v3_api
* Update POST/GET api for Hass * fix lint
2 parents 7ac95b9 + 0ea65ef commit cfb3920

File tree

2 files changed

+40
-37
lines changed

2 files changed

+40
-37
lines changed

API.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ On success
2222

2323
### HassIO
2424

25-
- `/supervisor/ping`
25+
- GET `/supervisor/ping`
2626

27-
- `/supervisor/info`
27+
- GET `/supervisor/info`
2828

2929
```json
3030
{
@@ -44,36 +44,36 @@ On success
4444
}
4545
```
4646

47-
- `/supervisor/update`
47+
- POST `/supervisor/update`
4848
Optional:
4949
```json
5050
{
5151
"version": "VERSION"
5252
}
5353
```
5454

55-
- `/supervisor/option`
55+
- POST `/supervisor/options`
5656
```json
5757
{
5858
"beta_channel": "true|false"
5959
}
6060
```
6161

62-
- `/supervisor/reload`
62+
- POST `/supervisor/reload`
6363

6464
Reload addons/version.
6565

66-
- `/supervisor/logs`
66+
- GET `/supervisor/logs`
6767

6868
Output the raw docker log
6969

7070
### Host
7171

72-
- `/host/shutdown`
72+
- POST `/host/shutdown`
7373

74-
- `/host/reboot`
74+
- POST `/host/reboot`
7575

76-
- `/host/info`
76+
- GET `/host/info`
7777
See HostControl info command.
7878
```json
7979
{
@@ -86,7 +86,7 @@ See HostControl info command.
8686
}
8787
```
8888

89-
- `/host/update`
89+
- POST `/host/update`
9090
Optional:
9191
```json
9292
{
@@ -96,9 +96,9 @@ Optional:
9696

9797
### Network
9898

99-
- `/network/info`
99+
- GET `/network/info`
100100

101-
- `/network/options`
101+
- POST `/network/options`
102102
```json
103103
{
104104
"hostname": "",
@@ -112,7 +112,7 @@ Optional:
112112

113113
### HomeAssistant
114114

115-
- `/homeassistant/info`
115+
- GET `/homeassistant/info`
116116

117117
```json
118118
{
@@ -121,21 +121,21 @@ Optional:
121121
}
122122
```
123123

124-
- `/homeassistant/update`
124+
- POST `/homeassistant/update`
125125
Optional:
126126
```json
127127
{
128128
"version": "VERSION"
129129
}
130130
```
131131

132-
- `/homeassistant/logs`
132+
- GET `/homeassistant/logs`
133133

134134
Output the raw docker log
135135

136136
### REST API addons
137137

138-
- `/addons/{addon}/info`
138+
- GET `/addons/{addon}/info`
139139
```json
140140
{
141141
"version": "VERSION",
@@ -146,37 +146,37 @@ Output the raw docker log
146146
}
147147
```
148148

149-
- `/addons/{addon}/options`
149+
- POST `/addons/{addon}/options`
150150
```json
151151
{
152152
"boot": "auto|manual",
153153
"options": {},
154154
}
155155
```
156156

157-
- `/addons/{addon}/start`
157+
- POST `/addons/{addon}/start`
158158

159-
- `/addons/{addon}/stop`
159+
- POST `/addons/{addon}/stop`
160160

161-
- `/addons/{addon}/install`
161+
- POST `/addons/{addon}/install`
162162
Optional:
163163
```json
164164
{
165165
"version": "VERSION"
166166
}
167167
```
168168

169-
- `/addons/{addon}/uninstall`
169+
- POST `/addons/{addon}/uninstall`
170170

171-
- `/addons/{addon}/update`
171+
- POST `/addons/{addon}/update`
172172
Optional:
173173
```json
174174
{
175175
"version": "VERSION"
176176
}
177177
```
178178

179-
- `/addons/{addon}/logs`
179+
- GET `/addons/{addon}/logs`
180180

181181
Output the raw docker log
182182

hassio/api/__init__.py

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,16 @@ def register_host(self, host_control):
3030
api_host = APIHost(self.config, self.loop, host_control)
3131

3232
self.webapp.router.add_get('/host/info', api_host.info)
33-
self.webapp.router.add_get('/host/reboot', api_host.reboot)
34-
self.webapp.router.add_get('/host/shutdown', api_host.shutdown)
35-
self.webapp.router.add_get('/host/update', api_host.update)
33+
self.webapp.router.add_post('/host/reboot', api_host.reboot)
34+
self.webapp.router.add_post('/host/shutdown', api_host.shutdown)
35+
self.webapp.router.add_post('/host/update', api_host.update)
3636

3737
def register_network(self, host_control):
3838
"""Register network function."""
3939
api_net = APINetwork(self.config, self.loop, host_control)
4040

4141
self.webapp.router.add_get('/network/info', api_net.info)
42-
self.webapp.router.add_get('/network/options', api_net.options)
42+
self.webapp.router.add_post('/network/options', api_net.options)
4343

4444
def register_supervisor(self, supervisor, addons, host_control):
4545
"""Register supervisor function."""
@@ -48,9 +48,11 @@ def register_supervisor(self, supervisor, addons, host_control):
4848

4949
self.webapp.router.add_get('/supervisor/ping', api_supervisor.ping)
5050
self.webapp.router.add_get('/supervisor/info', api_supervisor.info)
51-
self.webapp.router.add_get('/supervisor/update', api_supervisor.update)
52-
self.webapp.router.add_get('/supervisor/reload', api_supervisor.reload)
53-
self.webapp.router.add_get(
51+
self.webapp.router.add_post(
52+
'/supervisor/update', api_supervisor.update)
53+
self.webapp.router.add_post(
54+
'/supervisor/reload', api_supervisor.reload)
55+
self.webapp.router.add_post(
5456
'/supervisor/options', api_supervisor.options)
5557
self.webapp.router.add_get('/supervisor/logs', api_supervisor.logs)
5658

@@ -59,22 +61,23 @@ def register_homeassistant(self, dock_homeassistant):
5961
api_hass = APIHomeAssistant(self.config, self.loop, dock_homeassistant)
6062

6163
self.webapp.router.add_get('/homeassistant/info', api_hass.info)
62-
self.webapp.router.add_get('/homeassistant/update', api_hass.update)
64+
self.webapp.router.add_post('/homeassistant/update', api_hass.update)
6365
self.webapp.router.add_get('/homeassistant/logs', api_hass.logs)
6466

6567
def register_addons(self, addons):
6668
"""Register homeassistant function."""
6769
api_addons = APIAddons(self.config, self.loop, addons)
6870

6971
self.webapp.router.add_get('/addons/{addon}/info', api_addons.info)
70-
self.webapp.router.add_get(
72+
self.webapp.router.add_post(
7173
'/addons/{addon}/install', api_addons.install)
72-
self.webapp.router.add_get(
74+
self.webapp.router.add_post(
7375
'/addons/{addon}/uninstall', api_addons.uninstall)
74-
self.webapp.router.add_get('/addons/{addon}/start', api_addons.start)
75-
self.webapp.router.add_get('/addons/{addon}/stop', api_addons.stop)
76-
self.webapp.router.add_get('/addons/{addon}/update', api_addons.update)
77-
self.webapp.router.add_get(
76+
self.webapp.router.add_post('/addons/{addon}/start', api_addons.start)
77+
self.webapp.router.add_post('/addons/{addon}/stop', api_addons.stop)
78+
self.webapp.router.add_post(
79+
'/addons/{addon}/update', api_addons.update)
80+
self.webapp.router.add_post(
7881
'/addons/{addon}/options', api_addons.options)
7982
self.webapp.router.add_get('/addons/{addon}/logs', api_addons.logs)
8083

0 commit comments

Comments
 (0)