From 81770ad26bc52b5b878ee270bc5bfa240e0122b1 Mon Sep 17 00:00:00 2001 From: Nick O'Leary Date: Fri, 9 Mar 2018 10:02:39 +0000 Subject: [PATCH] Updated Editor Runtime API (markdown) --- Editor-Runtime-API.md | 132 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 132 insertions(+) diff --git a/Editor-Runtime-API.md b/Editor-Runtime-API.md index aa8b2ed..ebc0b8c 100644 --- a/Editor-Runtime-API.md +++ b/Editor-Runtime-API.md @@ -82,3 +82,135 @@ All URLs are relative to `settings.httpAdminRoot`, which defaults to `/`. | Comms API | | |--------------------------------------------|----------------------------------------------------------| | WebSocket /comms | | + + + +| | | | +|------------------------------|------------------------------------------------|-------------------------------------------------| +| api/admin/flow.js | GET /flow/:id | runtime.log.audit | +| | POST /flow | | +| | DELETE /flow/:id | runtime.nodes.getFlow(id) | +| | PUT /flow/:id | runtime.nodes.addFlow(flow) | +| | | "runtime.nodes.updateFlow(id,flow)" | +| | | runtime.nodes.removeFlow(id) | +| api/admin/flows.js | GET /flows | runtime.log.audit | +| | POST /flows | runtime.log.warn | +| | | | +| | | runtime.nodes.loadFlows | +| | | runtime.nodes.getFlows | +| | | runtime.nodes.setFlows | +| api/admin/nodes.js | GET /nodes | runtime.log.audit | +| | POST /nodes | | +| | | runtime.nodes.disableNode | +| | GET /\/nodes\/((@[^\/]+\/)?[^\/]+)$/ | runtime.nodes.enableNode | +| | PUT /\/nodes\/((@[^\/]+\/)?[^\/]+)$/ | runtime.nodes.getModuleInfo | +| | DELETE /\/nodes\/((@[^\/]+\/)?[^\/]+)$/ | runtime.nodes.getNodeConfig | +| | GET /\/nodes\/((@[^\/]+\/)?[^\/]+)\/([^\/]+)$/ | runtime.nodes.getNodeConfigs | +| | PUT /\/nodes\/((@[^\/]+\/)?[^\/]+)\/([^\/]+)$/ | runtime.nodes.getNodeIcons | +| | | runtime.nodes.getNodeInfo | +| | | runtime.nodes.getNodeList | +| | | runtime.nodes.installModule | +| | | runtime.nodes.uninstallModule | +| api/editor/comms.js | WS /comms | runtime.log.audit | +| | | runtime.log.trace | +| | | runtime.log.warn | +| | | | +| | | runtime.settings.adminAuth | +| | | runtime.settings.disableEditor | +| | | runtime.settings.httpAdminRoot | +| | | runtime.settings.webSocketKeepAliveTime | +| | | | +| | | runtime.events.on | +| | | runtime.events.removeListener | +| api/editor/credentials.js | GET /credentials/:type/:id | runtime.log.audit | +| | | | +| | | runtime.nodes.getCredentials | +| | | runtime.nodes.getCredentialDefinition | +| api/editor/index.js | | runtime.isStarted | +| | | runtime.i18n.registerMessageCatalogs | +| | | runtime.log.error | +| api/editor/library.js | POST /library/flows\/.*/ | runtime.log.audit | +| | GET /library/flows\/.*/ | runtime.log.warn | +| | GET /library/flows | | +| | | runtime.nodes.getNodeExampleFlows | +| | | runtime.nodes.getNodeExampleFlowPath | +| | | | +| | | runtime.storage.getLibraryEntry | +| | | runtime.storage.saveLibraryEntry | +| | | runtime.storage.getAllFlows | +| | | runtime.storage.getFlow | +| | | runtime.storage.saveFlow | +| api/editor/locales.js | GET /locales/nodes | runtime.nodes.getNodeList | +| | GET /locales\/(.+)\/?$/ | runtime.i18n.i | +| | | runtime.i18n.catalog | +| | | | +| api/editor/projects/index.js | | runtime.storage.projects.abortMerge | +| | | runtime.storage.projects.addRemote | +| | | runtime.storage.projects.commit | +| | | runtime.storage.projects.createProject | +| | | runtime.storage.projects.deleteBranch | +| | | runtime.storage.projects.deleteProject | +| | | runtime.storage.projects.getBranchStatus | +| | | runtime.storage.projects.getBranches | +| | | runtime.storage.projects.getBranches | +| | | runtime.storage.projects.getCommit | +| | | runtime.storage.projects.getCommits | +| | | runtime.storage.projects.getFile | +| | | runtime.storage.projects.getFileDiff | +| | | runtime.storage.projects.getFiles | +| | | runtime.storage.projects.getProject | +| | | runtime.storage.projects.getRemotes | +| | | runtime.storage.projects.getStatus | +| | | runtime.storage.projects.initialiseProject | +| | | runtime.storage.projects.listProjects | +| | | runtime.storage.projects.pull | +| | | runtime.storage.projects.push | +| | | runtime.storage.projects.removeRemote | +| | | runtime.storage.projects.resolveMerge | +| | | runtime.storage.projects.revertFile | +| | | runtime.storage.projects.setActiveProject | +| | | runtime.storage.projects.setBranch | +| | | runtime.storage.projects.stageFile | +| | | runtime.storage.projects.stageFile | +| | | runtime.storage.projects.unstageFile | +| | | runtime.storage.projects.unstageFile | +| | | runtime.storage.projects.updateProject | +| | | runtime.storage.projects.updateRemote | +| api/editor/settings.js | GET /settings | runtime.log.audit | +| | GET /settings/user | | +| | POST /settings/user | runtime.nodes.getCredentialKeyType | +| | | runtime.nodes.paletteEditorEnabled | +| | | | +| | | runtime.storage.projects.getActiveProject | +| | | runtime.storage.projects.flowFileExists | +| | | runtime.storage.projects.getFlowFilename | +| | | runtime.storage.projects.getCredentialsFilename | +| | | runtime.storage.projects.getGlobalGitUser | +| | | | +| | | runtime.settings.httpNodeRoot | +| | | runtime.settings.paletteCategories | +| | | runtime.settings.flowFilePretty | +| | | runtime.settings.getUserSettings | +| | | runtime.settings.setUserSettings | +| | | | +| api/editor/sshkeys.js | GET /settings/user/keys | runtime.storage.projects.ssh.listSSHKeys | +| | POST /settings/user/keys | runtime.storage.projects.ssh.getSSHKey | +| | GET /settings/user/keys/:id | runtime.storage.projects.ssh.generateSSHKey | +| | DELETE /settings/user/keys/:id | runtime.storage.projects.ssh.deleteSSHKey | +| | | | +| api/editor/theme.js | GET /theme/* | runtime.version | +| | | runtime.settings.editorTheme | +| api/editor/ui.js | GET / | runtime.nodes.getNodeIconPath | +| | GET /[public resources] | | +| | GET /icons | | +| | GET /icons/:module/:icon | | +| | GET /icons/:scope/:module/:icon | | +| | | | +| api/auth/index.js | GET /auth/login | runtime.settings.adminAuth | +| | POST /auth/token | runtime.settings.httpAdminRoot | +| | POST /auth/revoke | runtime.settings.editorTheme | +| api/auth/strategies.js | | runtime.log.audit | +| | | | +| api/auth/tokens.js | | runtime.storage.getSessions | +| | | runtime.storage.saveSessions | +