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
(→Getting the source) |
(→Devicetree) |
||
Line 23: | Line 23: | ||
! HTTP payload | ! HTTP payload | ||
|- | |- | ||
− | | devicetree.get( | + | | devicetree.get("node.subnode.leaf") |
− | | devicetree/ | + | | devicetree/node/subnode/leaf |
| GET | | GET | ||
| Nothing | | Nothing |
Revision as of 05:57, 12 July 2013
This page describes the current status of the Mihini Rest service
Contents
Specifications
Arguments
When it makes sense, URL is kept simpler as possible. Arguments are either passed in the URL as sub-URL or serialized 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("node.subnode.leaf") | devicetree/node/subnode/leaf | GET | Nothing |
devicetree.set(mypath, myvalue) | devicetree/mypath | PUT | The new value of "mypath" serialiazed with 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 | URL parameter | HTTP method | HTTP payload |
---|---|---|---|---|
update.localupdate(path, sync) | update/ | sync=[0-1] (optional, asynchronous by default) | POST | The tar archive sent as binary data in a http chunked request |
update.getstatus() | update/ | sync=[0-1] (optional, asynchronous by default) | GET | Nothing |
Suggestions
Feel free to send your feedbacks on the Mihini mailing list, suggestions for improvements are always welcome