Plugin Wizard
6 endpoints.
analyze_login
Section titled “analyze_login”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The handler is analyze_login in crates/lanrurugi-api/src/plugin_wizard/analyze_login.rs:53.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/plugin_wizard/mod.rs:22.
This response carries no example body.
This endpoint accepts a browser session only — the cookie set when you log in to your own instance. API tokens are refused by the server, so there is no token field here and the command above carries no Authorization header.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
POST /plugin-wizard/generate/start — see this module’s own top-level docs for why generation
Section titled “POST /plugin-wizard/generate/start — see this module’s own top-level docs for why generation”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The note below is the handler’s own documentation comment (crates/lanrurugi-api/src/plugin_wizard/generate.rs:169), quoted verbatim. It is written for maintainers of this codebase and may reference internal identifiers.
POST /plugin-wizard/generate/start — see this module’s own top-level docs for why generation
is split into this plus generate_stream rather than one POST returning JSON. Accepts the
request body as a raw [serde_json::Value] (not a typed GenerateRequest) specifically so
this endpoint never has to duplicate GenerateRequest’s own field/default handling — the real
typed parse happens once, at generate_stream time, against whatever was stashed here
unmodified.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/plugin_wizard/mod.rs:26.
This response carries no example body.
This endpoint accepts a browser session only — the cookie set when you log in to your own instance. API tokens are refused by the server, so there is no token field here and the command above carries no Authorization header.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
GET /plugin-wizard/generate/stream/{id} — the real EventSource-compatible streaming
Section titled “GET /plugin-wizard/generate/stream/{id} — the real EventSource-compatible streaming”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The note below is the handler’s own documentation comment (crates/lanrurugi-api/src/plugin_wizard/generate.rs:187), quoted verbatim. It is written for maintainers of this codebase and may reference internal identifiers.
GET /plugin-wizard/generate/stream/{id} — the real EventSource-compatible streaming
endpoint; see this module’s own top-level docs for the full event sequence. id is single-use
(removed from pending_generate_requests the moment this is called), so replaying the same id
(a stale bookmark, a double-click race) always yields generation_not_found rather than
silently re-running an old request.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/plugin_wizard/mod.rs:30.
This response carries no example body.
This endpoint accepts a browser session only — the cookie set when you log in to your own instance. API tokens are refused by the server, so there is no token field here and the command above carries no Authorization header.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
lookup
Section titled “lookup”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The handler is lookup in crates/lanrurugi-api/src/plugin_wizard/mod.rs:21.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/plugin_wizard/mod.rs:21.
This response carries no example body.
This endpoint accepts a browser session only — the cookie set when you log in to your own instance. API tokens are refused by the server, so there is no token field here and the command above carries no Authorization header.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The handler is save in crates/lanrurugi-api/src/plugin_wizard/save.rs:71.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/plugin_wizard/mod.rs:35.
This response carries no example body.
This endpoint accepts a browser session only — the cookie set when you log in to your own instance. API tokens are refused by the server, so there is no token field here and the command above carries no Authorization header.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
trial_run
Section titled “trial_run”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The handler is trial_run in crates/lanrurugi-api/src/plugin_wizard/trial_run.rs:114.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/plugin_wizard/mod.rs:34.
This response carries no example body.
This endpoint accepts a browser session only — the cookie set when you log in to your own instance. API tokens are refused by the server, so there is no token field here and the command above carries no Authorization header.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.