Updated Editor Runtime API (markdown)

Nick O'Leary 2018-03-20 13:07:25 +00:00
parent 7cb2427788
commit 2e68ecc473
1 changed files with 5 additions and 0 deletions

@ -14,6 +14,8 @@ The Authentication and Runtime API parts are already documented as part of the p
All URLs are relative to `settings.httpAdminRoot`, which defaults to `/`.
<details>
| Authentication | |
|--------------------------------------------|----------------------------------------------------------|
| GET /auth/login | Get the active authentication scheme |
@ -93,6 +95,9 @@ All URLs are relative to `settings.httpAdminRoot`, which defaults to `/`.
|--------------------------------------------|----------------------------------------------------------|
| WebSocket /comms | [Realtime comms between runtime and editor](Runtime-Editor-Comms-protocol) |
</details>
### 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.