Files
pikvm/docs
Aleksandr Prokudin d210a09ae9 Major update of the API documentation (#1557)
* Add initial HID API documentation

The first version has placeholders for responses, to be filled at a later time.

* Add initial Streamer API documentation

Currently missing information about query parameters and a few others things.
To be fixed after the first pass at all APIs.

* Add initial PiKVM Switch API and Redfish API documentation

This covers the basics and requires some testing to finalize the documentation

* Cleanup, part 1 of N

- Write short intro for HID and Streamer sections
- Fix the structure in HI and Streamer
- Standardize descriptions

* Cleanup, part 2 of N: more standardization

* Cleanup, part 3 of N:

- Standardize the markup for code blocks and CLI commands
- Enable the 'copy code' button in the theme

* Cleanup, part 4 of N:

- Actually commit the theme settings change (copy code button)
- Wrap URLs with ampersands in single quotes as requested by @mdevaev
- Clarify a few points as suggested by @mdevaev

* Cleanup, part 5 of N:

- Update MSD and GPIO docs for consistence's sake
- A bunch of FIXMEs to take care of alt a later time

* GPIO API: mention the pulse mode support requirement

* Cleanup Responses subsections, we'll do it differently

* Update API documentation: OCR options and examples, GPIO, and more
2025-07-14 22:38:21 +03:00
..
mic
2025-01-20 04:18:53 +02:00
2024-12-23 19:35:43 +02:00
2025-06-01 21:25:54 +03:00
…
…
…
2024-04-07 00:23:25 +03:00
…
2024-12-17 21:56:52 +02:00
2025-05-26 16:14:23 +03:00
…
…
2025-04-29 18:32:33 +03:00
2025-04-29 22:50:35 +03:00
2025-01-31 18:11:22 +02:00
…
2024-08-24 12:30:53 +03:00
2025-04-30 04:31:54 +03:00
2025-04-30 06:31:52 +03:00
2025-03-25 03:03:32 +02:00
2025-03-25 03:03:32 +02:00
2025-03-25 03:03:32 +02:00
fix
2025-06-01 21:44:11 +03:00
2025-04-30 06:31:52 +03:00
2025-03-25 03:03:32 +02:00
2025-04-30 04:31:54 +03:00
2025-06-06 22:08:55 +03:00
2025-03-25 03:03:32 +02:00
2025-04-30 04:31:54 +03:00
2025-03-25 03:03:32 +02:00
2025-01-31 18:11:22 +02:00
2025-05-24 02:41:03 +03:00
2025-05-02 23:14:24 +03:00
…
2024-12-06 18:13:39 +02:00
2025-06-01 21:25:54 +03:00
2025-06-01 22:08:22 +03:00
2024-06-18 15:13:31 +03:00
2025-06-06 17:04:17 +03:00
2025-04-30 06:31:52 +03:00
2025-03-11 23:18:34 +02:00
fix
2025-06-23 23:35:46 +03:00
2025-06-02 21:50:57 +03:00
2025-04-30 06:31:52 +03:00
2024-11-17 23:14:19 +02:00
2025-01-10 23:48:26 +02:00
…
fix
2025-05-24 03:01:18 +03:00
…
2025-03-03 03:28:05 +02:00
2025-01-04 18:54:59 +02:00
2025-01-04 18:54:59 +02:00
…
2025-02-10 14:09:09 +02:00
2025-05-26 03:54:43 +03:00
2025-06-03 21:03:42 +03:00
mic
2025-01-20 04:18:53 +02:00
2025-06-02 01:49:26 +03:00
2025-06-01 21:25:54 +03:00
2025-06-01 21:25:54 +03:00
2025-01-31 18:11:22 +02:00
2025-05-24 18:21:48 +03:00
2025-01-31 18:11:22 +02:00
2024-09-03 21:07:36 +03:00
2025-06-06 17:04:17 +03:00
…
2024-04-26 03:24:59 +03:00