mirror of https://github.com/node-red/node-red.git
Updated Editor Runtime API (markdown)
Nick O'Leary
parent
81770ad26b
commit
90245c8e0b
|
|
@ -84,133 +84,20 @@ All URLs are relative to `settings.httpAdminRoot`, which defaults to `/`.
|
|||
| 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 |
|
||||
|
||||
| | | | | | | |
|
||||
|------------------------------|-------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| 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)" | | | | |
|
||||
| api/admin/flows.js | GET /flows<br/>POST /flows | runtime.log.audit<br/>runtime.log.warn<br/>runtime.nodes.loadFlows<br/>runtime.nodes.getFlows<br/>runtime.nodes.setFlows | | | | |
|
||||
| api/admin/nodes.js | GET /nodes<br/>POST /nodes<br/>GET /\/nodes\/((@[^\/]+\/)?[^\/]+)$/ | runtime.nodes.enableNode<br/>PUT /\/nodes\/((@[^\/]+\/)?[^\/]+)$/ | runtime.nodes.getModuleInfo<br/>DELETE /\/nodes\/((@[^\/]+\/)?[^\/]+)$/ | runtime.nodes.getNodeConfig<br/>GET /\/nodes\/((@[^\/]+\/)?[^\/]+)\/([^\/]+)$/ | runtime.nodes.getNodeConfigs<br/>PUT /\/nodes\/((@[^\/]+\/)?[^\/]+)\/([^\/]+)$/ | runtime.nodes.getNodeIcons<br/>runtime.log.audit<br/>runtime.nodes.disableNode<br/>runtime.nodes.getNodeInfo<br/>runtime.nodes.getNodeList<br/>runtime.nodes.installModule<br/>runtime.nodes.uninstallModule |
|
||||
| api/editor/comms.js | WS /comms | runtime.log.audit<br/>runtime.log.trace<br/>runtime.log.warn<br/>runtime.settings.adminAuth<br/>runtime.settings.disableEditor<br/>runtime.settings.httpAdminRoot<br/>runtime.settings.webSocketKeepAliveTime<br/>runtime.events.on<br/>runtime.events.removeListener | | | | |
|
||||
| api/editor/credentials.js | GET /credentials/:type/:id | runtime.log.audit<br/>runtime.nodes.getCredentials<br/>runtime.nodes.getCredentialDefinition | | | | |
|
||||
| api/editor/index.js | | runtime.isStarted<br/>runtime.i18n.registerMessageCatalogs<br/>runtime.log.error | | | | |
|
||||
| api/editor/library.js | POST /library/flows\/.*/<br/>GET /library/flows\/.*/<br/>GET /library/flows | runtime.log.audit<br/>runtime.log.warn<br/>runtime.nodes.getNodeExampleFlows<br/>runtime.nodes.getNodeExampleFlowPath<br/>runtime.storage.getLibraryEntry<br/>runtime.storage.saveLibraryEntry<br/>runtime.storage.getAllFlows<br/>runtime.storage.getFlow<br/>runtime.storage.saveFlow | | | | |
|
||||
| api/editor/locales.js | GET /locales/nodes<br/>GET /locales\/(.+)\/?$/ | runtime.nodes.getNodeList<br/>runtime.i18n.i<br/>runtime.i18n.catalog | | | | |
|
||||
| api/editor/projects/index.js | | runtime.storage.projects.abortMerge<br/>runtime.storage.projects.addRemote<br/>runtime.storage.projects.commit<br/>runtime.storage.projects.createProject<br/>runtime.storage.projects.deleteBranch<br/>runtime.storage.projects.deleteProject<br/>runtime.storage.projects.getBranchStatus<br/>runtime.storage.projects.getBranches<br/>runtime.storage.projects.getBranches<br/>runtime.storage.projects.getCommit<br/>runtime.storage.projects.getCommits<br/>runtime.storage.projects.getFile<br/>runtime.storage.projects.getFileDiff<br/>runtime.storage.projects.getFiles<br/>runtime.storage.projects.getProject<br/>runtime.storage.projects.getRemotes<br/>runtime.storage.projects.getStatus<br/>runtime.storage.projects.initialiseProject<br/>runtime.storage.projects.listProjects<br/>runtime.storage.projects.pull<br/>runtime.storage.projects.push<br/>runtime.storage.projects.removeRemote<br/>runtime.storage.projects.resolveMerge<br/>runtime.storage.projects.revertFile<br/>runtime.storage.projects.setActiveProject<br/>runtime.storage.projects.setBranch<br/>runtime.storage.projects.stageFile<br/>runtime.storage.projects.stageFile<br/>runtime.storage.projects.unstageFile<br/>runtime.storage.projects.unstageFile<br/>runtime.storage.projects.updateProject<br/>runtime.storage.projects.updateRemote | | | | |
|
||||
| api/editor/settings.js | GET /settings<br/>GET /settings/user<br/>POST /settings/user | runtime.log.audit<br/>runtime.nodes.getCredentialKeyType<br/>runtime.nodes.paletteEditorEnabled<br/>runtime.storage.projects.getActiveProject<br/>runtime.storage.projects.flowFileExists<br/>runtime.storage.projects.getFlowFilename<br/>runtime.storage.projects.getCredentialsFilename<br/>runtime.storage.projects.getGlobalGitUser<br/>runtime.settings.httpNodeRoot<br/>runtime.settings.paletteCategories<br/>runtime.settings.flowFilePretty<br/>runtime.settings.getUserSettings<br/>runtime.settings.setUserSettings | api/editor/sshkeys.js | GET /settings/user/keys<br/>POST /settings/user/keys<br/>GET /settings/user/keys/:id<br/>DELETE /settings/user/keys/:id | runtime.storage.projects.ssh.listSSHKeys<br/>runtime.storage.projects.ssh.getSSHKey<br/>runtime.storage.projects.ssh.generateSSHKey<br/>runtime.storage.projects.ssh.deleteSSHKey | |
|
||||
| | | | | | | |
|
||||
| api/editor/theme.js | GET /theme/* | runtime.version<br/>runtime.settings.editorTheme | | | | |
|
||||
| api/editor/ui.js | GET /<br/>GET /[public resources]<br/>GET /icons<br/>GET /icons/:module/:icon<br/>GET /icons/:scope/:module/:icon | runtime.nodes.getNodeIconPath | | | | |
|
||||
| api/auth/index.js | GET /auth/login<br/>POST /auth/token<br/>POST /auth/revoke | api/auth/strategies.js<br/>runtime.settings.adminAuth<br/>runtime.settings.httpAdminRoot<br/>runtime.settings.editorTheme<br/>runtime.log.audit | | | | |
|
||||
| api/auth/tokens.js | | runtime.storage.getSessions<br/>runtime.storage.saveSessions | | | | |
|
||||
|
|
|
|||
Loading…
Reference in New Issue