frodovdr/node-red
1
0
Fork 0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00
Code Issues Releases Wiki Activity

Updated Editor Runtime API (markdown)

Nick O'Leary 2018-03-09 10:48:27 +00:00
parent 86e7bdb1e1
commit a812471447
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Editor-Runtime-API.md

@ -1,4 +1,14 @@
This is a snap-shot of the complete HTTP and WebSocket interface between the editor and runtime.
***Do not treat this as a fully documented public api - it is a working document***
This is a snap-shot (March 2018) of the complete HTTP and WebSocket interface between the editor and runtime and how it maps to the internals of the runtime.
This has been done to help rationalise the internal mappings and help stabilise the api.
- [HTTP/WS API](#external-api)
- [How the HTTP API maps to runtime node api](#internal-api)
### External API
The Authentication and Runtime API parts are already documented as part of the public API.
@ -83,6 +93,10 @@ All URLs are relative to `settings.httpAdminRoot`, which defaults to `/`.
|--------------------------------------------|----------------------------------------------------------|
| WebSocket /comms | |
### Internal API
This is a snapshot of how the api is split across source files, and how each of those files reaches into the runtime api. This is a pain to manually generate, so there may be omissions and could likely fall out of sync with reality as things are rationalised.
| | | |
|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| api/admin/flow.js | `GET /flow/:id`<br/>`POST /flow`<br/>`DELETE /flow/:id`<br/>`PUT /flow/:id` | "runtime.log.audit<br/>runtime.nodes.getFlow(id)<br/>runtime.nodes.addFlow(flow)<br/>runtime.nodes.updateFlow(id,flow)<br/>runtime.nodes.removeFlow(id)" |