Notice: this Wiki will be going read only early in 2024 and edits will no longer be 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) |
(→Getting the source) |
||
| Line 92: | Line 92: | ||
Get the full branch using git clone: | Get the full branch using git clone: | ||
| − | <pre style="width: | + | <pre style="width: 60em;">git clone ssh://git.eclipse.org/gitroot/mihini/org.eclipse.mihini.git -b bugs/402289 mihini |
</pre> | </pre> | ||
Revision as of 08:40, 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 |
Getting the source
Get the full branch using git clone:
git clone ssh://git.eclipse.org/gitroot/mihini/org.eclipse.mihini.git -b bugs/402289 mihini
If you already have cloned the Mihini repository, just checkout the branch locally:
git checkout -b bugs/402289 origin/bugs/402289