Skip to content

Commit

Permalink
docs: update changelog
Browse files Browse the repository at this point in the history
Also add a warning to the "webhooks" printer object description
stating that it should not be used to receive async "ready"
updates.

Signed-off-by:  Eric Callahan <[email protected]>
  • Loading branch information
Arksine committed Feb 7, 2025
1 parent fb6e416 commit 1117890
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,17 @@ The format is based on [Keep a Changelog].
should use the new endpoint, however it may be desirable to also
support the deprecated `full` and `client` endpoints for compatibility
with older API versions.
- **build**: Bump PDM-Backend to 2.4.3.
- **build**: Bump Apprise to 1.9.2
- **build**: Bump Tornado to 6.4.2
- **build**: Bump Streaming-form-data to 1.19.1
- **build**: Bump Jinja2 to 3.1.5

### Fixed
- **python_deploy**: fix "dev" channel updates for GitHub sources.
- **mqtt**: Publish the result of the Klipper status subscription request.
This fixes issues with MQTT clients missing the initial status updates
after Klippy restarts.

### Added
- **application**: Verify that a filename is present when parsing the
Expand Down
11 changes: 11 additions & 0 deletions docs/printer_objects.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,17 @@ The format is [X, Y, Z, E].

## webhooks

/// warning
Websocket and Unix Socket subscribers to the `webhooks` object
should not rely on it for asynchronous `startup`, `ready`, or
`error` state updates. By the time Moonraker has established
a connection to Klipper it is possible that the `webhooks`
state is already beyond the startup phase.

MQTT subscriptions will publish the first `state` detected
after Klippy exits the `startup` phase.
///

```{.json title="Printer Object Example"}
{
"state": "startup",
Expand Down

0 comments on commit 1117890

Please sign in to comment.