From a812471447af665d5538a1bd7182ebeea68ffcdb Mon Sep 17 00:00:00 2001 From: Nick O'Leary Date: Fri, 9 Mar 2018 10:48:27 +0000 Subject: [PATCH] Updated Editor Runtime API (markdown) --- Editor-Runtime-API.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/Editor-Runtime-API.md b/Editor-Runtime-API.md index 16f4a5f..533dfe0 100644 --- a/Editor-Runtime-API.md +++ b/Editor-Runtime-API.md @@ -1,4 +1,14 @@ -This is a snap-shot of the complete HTTP and WebSocket interface between the editor and runtime. +***Do not treat this as a fully documented public api - it is a working document*** + +This is a snap-shot (March 2018) of the complete HTTP and WebSocket interface between the editor and runtime and how it maps to the internals of the runtime. + +This has been done to help rationalise the internal mappings and help stabilise the api. + + + - [HTTP/WS API](#external-api) + - [How the HTTP API maps to runtime node api](#internal-api) + +### External API The Authentication and Runtime API parts are already documented as part of the public API. @@ -83,6 +93,10 @@ All URLs are relative to `settings.httpAdminRoot`, which defaults to `/`. |--------------------------------------------|----------------------------------------------------------| | WebSocket /comms | | +### Internal API + +This is a snapshot of how the api is split across source files, and how each of those files reaches into the runtime api. This is a pain to manually generate, so there may be omissions and could likely fall out of sync with reality as things are rationalised. + | | | | |------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | api/admin/flow.js | `GET /flow/:id`
`POST /flow`
`DELETE /flow/:id`
`PUT /flow/:id` | "runtime.log.audit
runtime.nodes.getFlow(id)
runtime.nodes.addFlow(flow)
runtime.nodes.updateFlow(id,flow)
runtime.nodes.removeFlow(id)" |