Eric Callahan
7e16dded0b
docs: add sqlite documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2024-05-21 06:18:46 -04:00
Eric Callahan
fca0cf3027
docs: update sensor documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2024-05-15 07:31:57 -04:00
Eric Callahan
326d23a509
docs: document history additions
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2024-05-05 06:29:21 -04:00
David Zwart
02144b472a
docs: more tweaks in remote API JSON formatting
...
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>
2024-04-27 06:16:59 -04:00
David Zwart
763d987309
docs: fix remote API JSON formatting and url(s)
...
"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>
2024-04-27 06:16:59 -04:00
Pedro Lamas
a3e4dac5fb
docs: corrects canbus peripherals response example
...
Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
2024-03-16 05:23:24 -04:00
Eric Callahan
6ec37fdacc
docs: add new doc structure for peripheral requests
...
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>
2024-02-01 10:28:20 -05:00
Eric Callahan
948b842351
docs: add peripheral API documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2024-02-01 10:28:14 -05:00
Eric Callahan
b620ebbc29
docs: document status endpoint and notification
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2024-01-21 08:24:03 -05:00
Eric Callahan
045075c396
docs: update spoolman proxy documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2024-01-21 08:24:01 -05:00
Eric Callahan
90e2ab6fcf
docs: add JSON-RPC over HTTP documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-12-22 16:51:57 -05:00
Eric Callahan
588454ffee
docs: document agent remote method registration
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-11-07 14:49:19 -05:00
Eric Callahan
a222ff0042
docs: update webcam API documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-10-03 07:41:32 -04:00
Eric Callahan
fe120952ee
docs: note "include_monitors" arg for the temperature store
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-08-03 07:57:36 -04:00
Eric Callahan
797c62389d
docs: add links to Klipper's status reference
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-07-31 16:44:23 -04:00
Eric Callahan
aebcd00f61
docs: note the anomalies field for update status
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-07-24 18:12:12 -04:00
Eric Callahan
fdc3e0eb0b
docs: document changes to update_manager
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-07-21 06:11:00 -04:00
Eric Callahan
5d8422ec52
docs: correct spoolman API documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-06-27 16:25:51 -04:00
Eric Callahan
09c29eab23
docs: minor spoolman updates
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-06-26 16:32:49 -04:00
Donkie
7172531386
docs: Fixed parmams typo
...
Signed-off-by: Daniel Hultgren <daniel.cf.hultgren@gmail.com>
2023-06-26 16:24:41 -04:00
Donkie
e6b3b8ba48
docs: Added section for spoolman
...
Signed-off-by: Daniel Hultgren <daniel.cf.hultgren@gmail.com>
2023-06-26 16:24:41 -04:00
Eric Callahan
0f4276d9b0
docs: document update_manager changes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-06-20 11:59:42 -04:00
quarkvalk
aa0f89c2a4
docs: fix JSON-RPC typo
...
Removed trailing comma in the JSON-RPC request example for
"Get Server Config", as that will raise an error.
Signed-off-by: Carl Rothe (carlrothe@gmail.com )
2023-06-08 07:16:28 -04:00
Eric Callahan
6c7dfe5921
docs: add new fields to webcam documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-04-23 07:30:08 -04:00
Eric Callahan
833519ecc3
docs: update file_manager documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-02-21 12:24:54 -05:00
Eric Callahan
3917c9cd56
docs: fix minor typos
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-02-20 17:47:39 -05:00
Morton Jonuschat
b2ba52ce3d
sensor: add support to track generic single value sensors
...
This feature implements a sensor component that can be used to
track/log generic sensors from multiple sources. Each sensor
can have properties like unit of measurement, accuracy and a
display name that help frontends display the tracked measurements.
Signed-off-by: Morton Jonuschat <mjonuschat+moonraker@gmail.com>
2023-02-20 17:43:41 -05:00
Eric Callahan
36de982692
docs: document file manager API fix
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-02-17 15:04:04 -05:00
Eric Callahan
90c7b80f37
docs: add bridge socket documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-02-06 19:55:36 -05:00
Eric Callahan
198bff6aba
docs: update_manger documenation change
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-02-06 11:17:26 -05:00
Eric Callahan
61d3182bea
docs: add thumbnail request documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-01-31 14:00:55 -05:00
Eric Callahan
3dbc99fd84
docs: update authorization documentation
...
Authorization APIs are a now available over the websocket.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-01-24 06:20:02 -05:00
Eric Callahan
486f659d20
docs: add new endpoints
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-01-08 13:50:09 -05:00
Pedro Lamas
a6b8a8a3e9
docs: add "reset" parameter to post endpoint
...
Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
2022-12-23 08:07:04 -05:00
Eric Callahan
f7d8af6e12
docs: add the "jump queue" API
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2022-12-22 14:09:15 -05:00
Eric Callahan
e628b243c2
docs: add canbus to /machine/system_info result
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2022-11-16 16:52:20 -05:00
Eric Callahan
7f58f2274e
docs: add unix socket documentation
2022-11-13 12:32:07 -05:00
Eric Callahan
5a3b1b6e5c
docs: fix list roots endpoint
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2022-11-07 07:54:43 -05:00
Eric Callahan
ddf3325dae
docs: document list roots
...
Update documentation to note that the uds now supports
templates.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2022-11-06 11:48:00 -05:00
Eric Callahan
6b3c78da71
docs: fix notifier debug endpoint
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2022-10-18 05:20:39 -04:00
pataar
b981dc109d
notify: add server endpoints for notifier to list and test them
...
Signed-off-by: Pieter Willekens <me@pataar.nl>
2022-10-18 05:18:30 -04:00
th33xitus
f0e4678fab
docs: use term "sudo" instead of "root"
...
Signed-off-by: Dominik Willner <th33xitus@gmail.com>
2022-10-15 06:11:14 -04:00
Eric Callahan
2603cc2e8f
docs: update deprecations
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2022-10-14 15:15:41 -04:00
Eric Callahan
c3cd24b3bf
docs: add "instance_ids" field to system_info response
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2022-10-14 15:15:41 -04:00
Eric Callahan
59471a7959
docs: update machine documentation
...
Add documentation for the new validation options, and document
changes to the sudo APIs.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2022-10-14 15:15:41 -04:00
alfrix
621739bb2b
docs: web_api: update allowed system services
2022-09-21 05:40:34 -04:00
Eric Callahan
e3cafb58bc
docs: update "machine" component documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2022-08-21 07:16:15 -04:00
Eric Callahan
d713076947
docs: add webcam documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2022-07-24 12:05:54 -04:00
Luca Schöneberg
58fa361c8c
authorization: implement /access/info endpoint
...
Signed-off-by: Luca Schöneberg <luca-schoeneberg@outlook.com>
2022-06-17 11:19:12 -04:00
Eric Callahan
a8b9fc0017
docs: document list feeds api
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2022-06-12 06:20:55 -04:00