docs: update API documentation

Document the new server.websocket.id method and update the documentation for the subscription APIs.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Arksine 2020-11-11 11:58:28 -05:00
parent 2ba41701e1
commit 4b2f3a6f5f
2 changed files with 51 additions and 10 deletions

View File

@ -1,6 +1,24 @@
This document keeps a record of all changes to Moonraker's remote This document keeps a record of all changes to Moonraker's remote
facing APIs. facing APIs.
### November 11th 2020
- The `server.websocket.id` API has been added. This returns a
unique ID that Moonraker uses to track each client connection.
As such, this API is only available over the websocket, there
is no complementary HTTP request.
- All HTTP API request may now include arguments in either the
query string or in the request's body.
- Subscriptions are now managed on a per connection basis. Each
connection will only recieve updates for objects in which they
are currently subscribed. If an "empty" request is sent, the
subscription will be cancelled.
- The `POST /printer/object/subscribe` now requires a
`connection_id` argument. This is used to identify which
connection's associated subscription should be updated.
Currenlty subscriptions are only supported over the a
websocket connection, one may use the id received from
`server.websocket.id`.
### November 2nd 2020 ### November 2nd 2020
- The `GET /server/files/directory` endpoint now accepts a new - The `GET /server/files/directory` endpoint now accepts a new
optional argument, `extended`. If `extended=true`, then optional argument, `extended`. If `extended=true`, then

View File

@ -11,8 +11,9 @@ of:
`{result: <response data>}` `{result: <response data>}`
The command matches the original command request, the result is the return Arguments sent via the HTTP APIs may either be included in the query string
value generated from the request. or as part of the request's body. All of the examples in this document
use the query string for arguments.
Websocket requests are returned in JSON-RPC format: Websocket requests are returned in JSON-RPC format:
`{jsonrpc: "2.0", "result": <response data>, id: <request id>}` `{jsonrpc: "2.0", "result": <response data>, id: <request id>}`
@ -143,15 +144,25 @@ available for query.
### Subscribe to printer object status: ### Subscribe to printer object status:
- HTTP command:\ - HTTP command:\
`POST /printer/objects/subscribe?gcode=gcode_position,bus&extruder=target` `POST /printer/objects/subscribe?connection_id=123456789&
gcode=gcode_position,bus&extruder=target`
Note: The HTTP API requires that a `connection_id` is passed via the query
string or as part of the form. This should be the
[ID reported](#get-websocket-id) from a currently connected websocket. A
request that includes only the `connection_id` argument will cancel the
subscription on the specified websocket.
- Websocket command:\ - Websocket command:\
`{jsonrpc: "2.0", method: "printer.objects.subscribe", params: `{jsonrpc: "2.0", method: "printer.objects.subscribe", params:
{objects: {gcode: null, toolhead: ["position", "status"]}}, {objects: {gcode: null, toolhead: ["position", "status"]}},
id: <request id>}` id: <request id>}`
Note that if `objects` is an empty object then the subscription will
be cancelled.
- Returns:\ - Returns:\
Status data for all currently subscribed objects, with the format matching that of Status data for objects in the request, with the format matching that of
the `/printer/objects/query`: the `/printer/objects/query`:
```json ```json
@ -172,12 +183,7 @@ available for query.
See [printer_objects.md](printer_objects.md) for details on the printer objects See [printer_objects.md](printer_objects.md) for details on the printer objects
available for subscription. available for subscription.
Note that Moonraker's current behavior is to maintain a superset of all Status updates for subscribed objects are sent asynchronously over the
subscriptions, thus you may receive updates for objects that you did not
request. This behavior is subject to change in the future (where each
client receives only the subscriptions it requested).
Future updates for subscribed objects are sent asynchronously over the
websocket. See the `notify_status_update` notification for details. websocket. See the `notify_status_update` notification for details.
### Query Endstops ### Query Endstops
@ -290,6 +296,23 @@ for (let resp of result.gcode_store) {
will be disconnected. A restart will result in the creation will be disconnected. A restart will result in the creation
of a new server instance where the configuration is reloaded. of a new server instance where the configuration is reloaded.
## Get Websocket ID
- HTTP command:\
Not Available
- Websocket command:
`{jsonrpc: "2.0", method: "server.websocket.id", id: <request id>}`
- Returns:\
This connected websocket's unique identifer in the format shown below.
Note that this API call is only available over the websocket.
```json
{
websocket_id: <int>
}
```
## Gcode Controls ## Gcode Controls
### Run a gcode: ### Run a gcode: