|
|
| (16 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| − | This page describes the current status of the Mihini Rest service
| + | #REDIRECT [[Mihini/REST_API]] |
| − | | + | |
| − | | + | |
| − | == 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 ===
| + | |
| − | | + | |
| − | {| border="1" cellspacing="0" cellpadding="5"
| + | |
| − | |-
| + | |
| − | ! Module API
| + | |
| − | ! Rest URL
| + | |
| − | ! HTTP method
| + | |
| − | ! HTTP payload
| + | |
| − | |-
| + | |
| − | | devicetree.get(mypath)
| + | |
| − | | devicetree/mypath
| + | |
| − | | GET
| + | |
| − | | Nothing
| + | |
| − | |-
| + | |
| − | | devicetree.set(mypath, myvalue)
| + | |
| − | | devicetree/mypath
| + | |
| − | | PUT
| + | |
| − | | The new value of "mypath" serialiazed with JSON
| + | |
| − | |}
| + | |
| − | | + | |
| − | === Application container ===
| + | |
| − | | + | |
| − | {| border="1" cellspacing="0" cellpadding="5"
| + | |
| − | |-
| + | |
| − | ! 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 ===
| + | |
| − | | + | |
| − | {| 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
| + | |
| − | |}
| + | |
| − | | + | |
| − | == Getting the source ==
| + | |
| − | | + | |
| − | Get the full branch using git clone:
| + | |
| − | <pre style="width: 60em;">git clone ssh://git.eclipse.org/gitroot/mihini/org.eclipse.mihini.git -b bugs/402289 mihini
| + | |
| − | </pre>
| + | |
| − | | + | |
| − | If you already have cloned the Mihini repository, just checkout the branch locally:
| + | |
| − | <pre style="width: 45em;">git checkout -b bugs/402289 origin/bugs/402289
| + | |
| − | </pre>
| + | |
| − | | + | |
| − | == Suggestions ==
| + | |
| − | | + | |
| − | Feel free to send your feedbacks on the Mihini mailing list, suggestions for improvements are always welcome
| + | |
