From 58e20a9725d6305187ab7e1fb704e7bb89293803 Mon Sep 17 00:00:00 2001 From: Nick O'Leary Date: Tue, 20 Mar 2018 17:21:48 +0000 Subject: [PATCH] Updated Editor Runtime API (markdown) --- Editor-Runtime-API.md | 88 +++++++++++++++++++++---------------------- 1 file changed, 44 insertions(+), 44 deletions(-) diff --git a/Editor-Runtime-API.md b/Editor-Runtime-API.md index 3a2b111..7801c59 100644 --- a/Editor-Runtime-API.md +++ b/Editor-Runtime-API.md @@ -150,14 +150,14 @@ The following table shows the simplified runtime api.
-|Authentication|||| +|||| |--------------------------------------------|--------------------------------------------|----------------------------------------------------------|----------------------------------------------------------| -|api/auth/index.js|GET /auth/login|Get the active authentication scheme|| +|**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|||| -|--------------------------------------------|--------------------------------------------|----------------------------------------------------------|----------------------------------------------------------| +|||| +|**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| |api/admin/flow.js|POST /flow|Add a flow to the active configuration|runtime.flows.addFlow| @@ -171,9 +171,8 @@ 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|||| -|--------------------------------------------|--------------------------------------------|----------------------------------------------------------|----------------------------------------------------------| +|||| +|**Editor API**|||| |api/editor/ui.js|GET /|Get the editor html|| |api/editor/ui.js|GET /red/*|Get the main editor js/css/images|| |api/editor/ui.js|GET /vendor/*|Get 3rd-party libraries used by the editor|| @@ -191,46 +190,47 @@ 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|||| -|--------------------------------------------|--------------------------------------------|----------------------------------------------------------|----------------------------------------------------------| +|||| +|**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|runtime.storage.projects.*| -|api/editor/projects/index.js|POST /projects|Create project|runtime.storage.projects.*| -|api/editor/projects/index.js|GET /projects/:id|Get project metadata|runtime.storage.projects.*| -|api/editor/projects/index.js|PUT /projects/:id|Update a project|runtime.storage.projects.*| -|api/editor/projects/index.js|DELETE /projects/:id|Delete project|runtime.storage.projects.*| -|api/editor/projects/index.js|GET /projects/:id/status|"Get project status - files| commit counts| branch info"|runtime.storage.projects.*| -|api/editor/projects/index.js|GET /projects/:id/files|Project file listing|runtime.storage.projects.*| -|api/editor/projects/index.js|GET /projects/:id/files/:treeish/*|Get file content in a given tree (index/stage)|runtime.storage.projects.*| -|api/editor/projects/index.js|DELETE /projects/:id/files/_/*|Revert a file (delete from the stage tree)|runtime.storage.projects.*| -|api/editor/projects/index.js|POST /projects/:id/stage/*|Stage a file|runtime.storage.projects.*| -|api/editor/projects/index.js|POST /projects/:id/stage|Stage multiple files|runtime.storage.projects.*| -|api/editor/projects/index.js|POST /projects/:id/commit|Commit changes|runtime.storage.projects.*| -|api/editor/projects/index.js|DELETE /projects/:id/stage/*|Unstage a file|runtime.storage.projects.*| -|api/editor/projects/index.js|DELETE /projects/:id/stage|Unstage multiple files|runtime.storage.projects.*| -|api/editor/projects/index.js|GET /projects/:id/diff/:type/*|Get a file diff|runtime.storage.projects.*| -|api/editor/projects/index.js|GET /projects/:id/commits|Get a list of commits|runtime.storage.projects.*| -|api/editor/projects/index.js|GET /projects/:id/commits/:sha|Get an individual commit details|runtime.storage.projects.*| -|api/editor/projects/index.js|POST /projects/:id/push/?*|Push local commits to remote|runtime.storage.projects.*| -|api/editor/projects/index.js|POST /projects/:id/pull/?*|Pull remote commits|runtime.storage.projects.*| -|api/editor/projects/index.js|DELETE /projects/:id/merge|Abort an ongoing merge|runtime.storage.projects.*| -|api/editor/projects/index.js|POST /projects/:id/resolve/*|Resolve a merge|runtime.storage.projects.*| -|api/editor/projects/index.js|GET /projects/:id/branches|Get a list of local branches|runtime.storage.projects.*| -|api/editor/projects/index.js|DELETE /projects/:id/branches/:branchName|Delete a local branch - ?force=true|runtime.storage.projects.*| -|api/editor/projects/index.js|GET /projects/:id/branches/remote|Get a list of remote branches|runtime.storage.projects.*| -|api/editor/projects/index.js|GET /projects/:id/branches/remote/*/status|Get branch status - commit counts/ahead/behind|runtime.storage.projects.*| -|api/editor/projects/index.js|POST /projects/:id/branches|Set the active local branch|runtime.storage.projects.*| -|api/editor/projects/index.js|GET /projects/:id/remotes|Get a list of remotes|runtime.storage.projects.*| -|api/editor/projects/index.js|POST /projects/:id/remotes|Add a remote|runtime.storage.projects.*| -|api/editor/projects/index.js|DELETE /projects/:id/remotes/:remoteName|Delete a remote|runtime.storage.projects.*| -|api/editor/projects/index.js|PUT /projects/:id/remotes/:remoteName|Update a remote|runtime.storage.projects.* +|||| +|**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/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)|| +|api/editor/projects/index.js|POST /projects/:id/stage/*|Stage a file|| +|api/editor/projects/index.js|POST /projects/:id/stage|Stage multiple files|| +|api/editor/projects/index.js|POST /projects/:id/commit|Commit changes|| +|api/editor/projects/index.js|DELETE /projects/:id/stage/*|Unstage a file|| +|api/editor/projects/index.js|DELETE /projects/:id/stage|Unstage multiple files|| +|api/editor/projects/index.js|GET /projects/:id/diff/:type/*|Get a file diff|| +|api/editor/projects/index.js|GET /projects/:id/commits|Get a list of commits|| +|api/editor/projects/index.js|GET /projects/:id/commits/:sha|Get an individual commit details|| +|api/editor/projects/index.js|POST /projects/:id/push/?*|Push local commits to remote|| +|api/editor/projects/index.js|POST /projects/:id/pull/?*|Pull remote commits|| +|api/editor/projects/index.js|DELETE /projects/:id/merge|Abort an ongoing merge|| +|api/editor/projects/index.js|POST /projects/:id/resolve/*|Resolve a merge|| +|api/editor/projects/index.js|GET /projects/:id/branches|Get a list of local branches|| +|api/editor/projects/index.js|DELETE /projects/:id/branches/:branchName|Delete a local branch - ?force=true|| +|api/editor/projects/index.js|GET /projects/:id/branches/remote|Get a list of remote branches|| +|api/editor/projects/index.js|GET /projects/:id/branches/remote/*/status|Get branch status - commit counts/ahead/behind|| +|api/editor/projects/index.js|POST /projects/:id/branches|Set the active local branch|| +|api/editor/projects/index.js|GET /projects/:id/remotes|Get a list of remotes|| +|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*|
\ No newline at end of file