Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Mihini/Rest"
< Mihini
(→Description) |
(→API) |
||
| Line 67: | Line 67: | ||
| PUT | | PUT | ||
| A boolean value corresponding to "autostart" and serialized with JSON | | A boolean value corresponding to "autostart" and serialized with JSON | ||
| + | |} | ||
| + | |||
| + | === Update === | ||
| + | |||
| + | {| border="1" cellspacing="0" cellpadding="5" | ||
| + | |- | ||
| + | ! Module API | ||
| + | ! Rest URL | ||
| + | ! HTTP method | ||
| + | ! HTTP payload | ||
| + | |- | ||
| + | | update.localupdate(path, sync) | ||
| + | | update/ | ||
| + | | POST | ||
| + | | The tarball sent as binary-data (type mime + http multipart ??) ?? | ||
| + | |- | ||
| + | | update.getstatus() | ||
| + | | update/ | ||
| + | | GET | ||
| + | | Nothing | ||
|} | |} | ||
Revision as of 08:29, 27 May 2013
This page describes the current status of the Mihini Rest service (not finished yet)
Contents
Specifications
Arguments
When it makes sense, URL is kept simpler as possible. Arguments are either passed in the URL as SUB-URL or serialiazed with JSON and put in the HTTP request (as payload)
Returned values
Each Rest function returns the same value as the function to which it corresponds, except that it is serialized with JSON
API
Devicetree
| Module API | Rest URL | HTTP method | HTTP payload |
|---|---|---|---|
| devicetree.get(mypath) | devicetree/mypath | GET | Nothing |
| devicetree.set(mypath, myvalue) | devicetree/mypath | PUT (Perhaps POST is better ?) | The new value of "mypath" serialiazed as JSON |
Application container
| Module API | Rest URL | HTTP method | HTTP payload |
|---|---|---|---|
| appcon.list() | application/ | GET | Nothing |
| appcon.status(id) | application/id | GET | Nothing |
| appcon.start(id) | application/id/start | PUT | Nothing |
| appcon.stop(id) | application/id/stop | PUT | Nothing |
| appcon.configure(id, autostart) | application/id/configure | PUT | A boolean value corresponding to "autostart" and serialized with JSON |
Update
| Module API | Rest URL | HTTP method | HTTP payload |
|---|---|---|---|
| update.localupdate(path, sync) | update/ | POST | The tarball sent as binary-data (type mime + http multipart ??) ?? |
| update.getstatus() | update/ | GET | Nothing |