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 <arksine.code@gmail.com>
Moonraker's external API documentation has been significantly
overhauled in an effort to improve clarity and readability.
All parameters and responses are documented with specifications.
Tables and other elements are used to make documentation more
visible and less verbose.
Spelling and other corrections have also been added.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
This extension is used to collapse the example responses presented
in the API documentation, which can be quite long.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
Remote API docs tweaks. Some leading commas removed for JSON serialization. Also found an unclosed json section.
Signed-off-by: David Zwart <davidzwa@gmail.com>
"Delete a webcam" section contained a wrong url. Some response examples were wrapped in result, and some others were not. I've removed "result": { } for consistency. Finally I've removed many leading commas causing problems with JSON deserialization.
Signed-off-by: David Zwart <davidzwa@gmail.com>
The sensor configuration isn't useful unless the user configures a
template that calls "set_result" to update fields for the desired
template. Remove the default payload template and require
that it be configured.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
This enables customizing the time of day within which periodic refresh occurs.
Previously docs said it happens between 12am-4am which is misleading,
because the code effectively allowed refresh until 4:59:59 AM.
The default window is now '0-5', which is practically the same as before.
The comment about checking every 24h hours has been fixed as well.
This hasn't been true since commit c4fa76f21792943ea512d24326259f01d2fa7e89
Signed-off-by: Kamil Domański <kamil@domanski.co>
This adds a new structure for API documentation, making each
aspect visible and uniform. The parameters, response, and
schema are collapsible, allowing for easier navigation.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
The material theme is more feature complete and flexibile,
providing better documentation for APIs and such. This
commit is just the initial move. The documents are functional,
but the layout and color schemes are subject to change.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
When "initial_state" is configured, bound services will be
initialzed based on that state...stopped if the state is
"off", started if its "on.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>