mirror of https://github.com/node-red/node-red.git
Updated Editor Runtime API (markdown)
Nick O'Leary
parent
f0b362692c
commit
86e7bdb1e1
|
|
@ -83,19 +83,20 @@ All URLs are relative to `settings.httpAdminRoot`, which defaults to `/`.
|
|||
|--------------------------------------------|----------------------------------------------------------|
|
||||
| WebSocket /comms | |
|
||||
|
||||
| | | | | | |
|
||||
|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| 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\/((@[^\/]+\/)?[^\/]+)$/`<br/>`PUT /\/nodes\/((@[^\/]+\/)?[^\/]+)$/`<br/>`DELETE /\/nodes\/((@[^\/]+\/)?[^\/]+)$/`<br/>`GET /\/nodes\/((@[^\/]+\/)?[^\/]+)\/([^\/]+)$/`<br/>`PUT /\/nodes\/((@[^\/]+\/)?[^\/]+)\/([^\/]+)$/` | runtime.nodes.enableNode<br/>runtime.nodes.getModuleInfo<br/>runtime.nodes.getNodeConfig<br/>runtime.nodes.getNodeConfigs<br/>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 | `* /projects/*` | 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 | | | |
|
||||
| | | |
|
||||
|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| 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\/((@[^\/]+\/)?[^\/]+)$/`<br/>`PUT /\/nodes\/((@[^\/]+\/)?[^\/]+)$/`<br/>`DELETE /\/nodes\/((@[^\/]+\/)?[^\/]+)$/`<br/>`GET /\/nodes\/((@[^\/]+\/)?[^\/]+)\/([^\/]+)$/`<br/>`PUT /\/nodes\/((@[^\/]+\/)?[^\/]+)\/([^\/]+)$/` | runtime.nodes.enableNode<br/>runtime.nodes.getModuleInfo<br/>runtime.nodes.getNodeConfig<br/>runtime.nodes.getNodeConfigs<br/>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 | `* /projects/*` | 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