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-20 17:24:04 +00:00
parent 58e20a9725
commit dcfd776774
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Editor-Runtime-API.md

@ -150,13 +150,13 @@ The following table shows the simplified runtime api.
<details>
||||
|--------------------------------------------|--------------------------------------------|----------------------------------------------------------|----------------------------------------------------------|
|**Authentication***||||
|||||
|-----|---------------|----------------------|-------------|
|**Authentication**||||
|api/auth/index.js|GET /auth/login|Get the active authentication scheme|*tbd*|
|api/auth/index.js|POST /auth/token|Exchange credentials for access token||
|api/auth/index.js|POST /auth/revoke|Revoke an access token||
||||
|||||
|**Runtime API**||||
|api/admin/flows.js|GET /flows|Get the active flow configuration|runtime.flows.getFlows|
|api/admin/flows.js|POST /flows|Set the active flow configuration|runtime.flows.setFlows|
@ -171,7 +171,7 @@ The following table shows the simplified runtime api.
|api/admin/nodes.js|DELETE /nodes/:module|Remove a node module|runtime.nodes.removeModule|
|api/admin/nodes.js|GET /nodes/:module/:set|Get a node module set information|runtime.nodes.getNodeSet|
|api/admin/nodes.js|PUT /nodes/:module/:set|Enable/Disable a node set|runtime.nodes.enableNodeSet / runtime.nodes.disableNodeSet|
||||
|||||
|**Editor API**||||
|api/editor/ui.js|GET /|Get the editor html||
|api/editor/ui.js|GET /red/*|Get the main editor js/css/images||
@ -190,21 +190,21 @@ The following table shows the simplified runtime api.
|api/editor/ui.js|GET /icons|Get the list of all available node icons|runtime.nodes.getIconList|
|api/editor/ui.js|GET /icons/:module/:icon|Get a module-provided node icon|runtime.nodes.getIcon|
|api/editor/ui.js|GET /icons/:icon|Get a node icon from the core set||
||||
|||||
|**Library API**||||
|api/editor/library.js|POST /library/flows/*||runtime.library.setEntry|
|api/editor/library.js|GET /library/flows/*||runtime.library.getEntry|
|api/editor/library.js|GET /library/flows||runtime.library.getEntries|
|api/editor/library.js|GET /library/:type/*|||
|api/editor/library.js|POST /library/:type/*|||
||||
|||||
|**Projects API**||||
|api/editor/projects/index.js|GET /projects|List all projects|*tbd*|
|api/editor/projects/index.js|POST /projects|Create project||
|api/editor/projects/index.js|GET /projects/:id|Get project metadata||
|api/editor/projects/index.js|PUT /projects/:id|Update a project||
|api/editor/projects/index.js|DELETE /projects/:id|Delete project||
|api/editor/projects/index.js|GET /projects/:id/status|"Get project status - files| commit counts| branch info"||
|api/editor/projects/index.js|GET /projects/:id/status|Get project status - files/commit counts/branch info||
|api/editor/projects/index.js|GET /projects/:id/files|Project file listing||
|api/editor/projects/index.js|GET /projects/:id/files/:treeish/*|Get file content in a given tree (index/stage)||
|api/editor/projects/index.js|DELETE /projects/:id/files/_/*|Revert a file (delete from the stage tree)||
@ -229,8 +229,9 @@ The following table shows the simplified runtime api.
|api/editor/projects/index.js|POST /projects/:id/remotes|Add a remote||
|api/editor/projects/index.js|DELETE /projects/:id/remotes/:remoteName|Delete a remote||
|api/editor/projects/index.js|PUT /projects/:id/remotes/:remoteName|Update a remote|
||||
|||||
|**Comms API**||||
|api/editor/comms.js|WebSocket /comms|Realtime comms between runtime and editor|*tbd*|
</details>