Conversation
Multipart artefact upload, chunked assets, X-API-JobToken routes, and the worker WebSocket are only reachable from inside a running job on an os-autoinst worker — the artefact route even 404s with 'No worker assigned' outside that context. Implementing any of it means building a worker: a different program, auth model, and wire format, not a gap in this REST client. State the exclusion explicitly next to the existing scope bullets, and document the escape hatch that already exists for a caller who does hold a job token: PreparedRequest's fields are public and Client::execute takes one directly, so nothing is walled off.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
ruoqais an external REST client. Three routes are reachable only frominside a running job on an os-autoinst worker:
POST /api/v1/jobs/:id/artefact) — the onlyfile-upload route in the whole v1 API, and it 404s with
No worker assignedunless a worker is currently running the jobX-API-JobTokenroutes (whoami,mutex,barrier,mm) thatos-autoinst test modules use to synchronise during a job run
/api/v1/ws/:workerid)Implementing any of this means implementing a worker — a different program
with a different auth model (
JOBTOKEN), lifecycle, and wire format, not agap in this REST client.
What changed
README.md's## Behavioursection states the exclusion next to theexisting scope bullets (no typed response models, no CLI binary) and
names the four excluded surfaces.
a job token:
PreparedRequest's fields are public andClient::executetakes one directly, backed by a
no_rundoctest so it can't silentlydrift.
Documentation-only change — no
src/files touched.Verification
cargo fmt --checkcargo clippy --all-targets --locked -- -D warningscargo test --locked(doctest compiles)cargo check --locked --all-targetscargo deny check