Expand description
HTTP wire types exchanged between the CLI, the edge worker, the scheduler Durable Object, and trusted CI.
Field docs describe the wire meaning of each payload; the validated
identity newtypes from crate::identity carry the invariants.
Structs§
- Admin
InFlight - One in-flight (dispatched/running) queue row in
AdminStatus. - Admin
Status - Response of
GET /api/v1/admin/status— the scheduler’s operator view. - Admin
Target Stats - Per-target completion tallies over the trailing 24 hours.
- Admission
Request - Request body for
POST /api/v1/admissions: the misses a client’s local index resolution found, plus the resolved graph the edge needs to re-derive the enqueue set with dominator pruning. - Artifact
Index Page - Response body for
GET /api/v1/admin/index/{target}/{rustc_version}. - Artifact
Inspection - Response of
GET /api/v1/admin/artifacts/{target}/{rustc_version}/{c_metadata}: the D1 catalog row plus the bundle image’s OCI manifest read from GHCR. - Artifact
List Query - Query for
GET /api/v1/admin/artifacts— a bounded catalog listing used to preview a prune and for ad-hoc inspection. - Artifact
Prune Request - Request body for
POST /api/v1/admin/artifacts/prune. - Artifact
Prune Response - Response of
POST /api/v1/admin/artifacts/prune. - Artifact
Record - Artifact record CI POSTs to the edge’s register endpoint after a build.
- Build
Complete Report - CI reports job completion to the scheduler DO.
- Build
Task Payload - The task the scheduler dispatches to
stow-build, carried verbatim as theworkflow_dispatchinput of the trusted build workflow. - Coverage
Artifact - One servable artifact identity inside
CoverageTarget. - Coverage
Target - One target’s servable identities inside
CrateCoverage. - Crate
Coverage - Response of
GET /api/v1/admin/coverage/{crate}— per-CI-target servable identities for one crate (one version whenversionwas given). - Crate
Feature - One feature a crate version declares.
- Crate
Features Response - Response body for
GET /api/v1/crates/{crate_name}/versions/{version}/features. - Crate
Request - Request body for
POST /api/v1/requests: a human asking for one crate to be built into the public cache. - Crate
Request Outcome - Response of
POST /api/v1/requests: what the edge resolved and where each supported target stands. - Crate
Request Target - Per-target outcome inside a
CrateRequestOutcome. - Crate
Search Hit - One crate in a
GET /api/v1/crates/searchresult. - Crate
Search Response - Response body for
GET /api/v1/crates/search. - Crate
Versions Response - Response body for
GET /api/v1/crates/{crate_name}/versions. - Dependency
Graph Entry - A normalized dependency entry from a resolved Cargo dependency graph.
- Enqueue
Admission - Admission ticket the edge mints for one canonical enqueue task when a public request misses the cache.
- Enqueue
Dependency - One task-level dependency that must complete before its parent dispatches.
- Enqueue
Request - Request body for scheduler task submission.
- Enqueue
Ticket - Request body for
POST /api/v1/enqueue: the redemption of anEnqueueAdmission. - Observe
Run - Body for the scheduler DO’s
/tasks/observe-run. - OciDescriptor
- One blob descriptor inside an
OciManifest. - OciManifest
- OCI image manifest — the document a
manifests/<reference>GET serves. - Panic
Switch - The anonymous-traffic circuit breaker (“panic switch”).
- Preheat
Plan Request - Request body for
POST /api/v1/admin/preheat/plan— a dry run of the resolver’s closure expansion and dominance pruning for one crate request. Nothing is enqueued. - Preheat
Plan Response - Response of
POST /api/v1/admin/preheat/plan. - Preheat
Plan Target - One target’s enqueue plan inside
PreheatPlanResponse. - Project
Source - A git checkout the trusted build compiles instead of a crates.io
tarball, resolved by the checkout’s own
Cargo.lock. - Queue
Filter - Row filter for
GET /api/v1/admin/queueand thefilterhalf of aQueueSelector. - Queue
Mutation Result - Response of the
queue retry|cancel|promote|purgeendpoints: how many rows the transition touched. - Queue
Selector - Selector for
POST /api/v1/admin/queue/{retry,cancel,promote,purge}. - Queue
Task - One queue row as
GET /api/v1/admin/queuereports it. - Register
Artifacts Request - Request body for
POST /api/v1/admin/artifacts/register. - Request
Status - Point-in-time view of one scheduler task, returned by
GET /api/v1/requests/{task_id}. - Resolved
Dependency Graph Dependency - One exact dependency edge in a client-resolved Cargo graph.
- Resolved
Dependency Graph Entry - One exact crates.io package node resolved from the client’s current lockfile graph.
- Scheduler
Status - Scheduler DO queue status for monitoring.
- Scheduler
Submit Response - Response of
POST /api/v1/scheduler/tasks/submit— what a request batch became after canonicalization and enqueue. - Usage
Stat Entry - One
(name, hits)bucket of aUsageStatsleaderboard. - Usage
Stats - Public aggregate usage statistics served by
GET /api/v1/stats.
Enums§
- Crate
Request State - Per-target state reported inside
CrateRequestTarget. - Enqueue
Source - Where an enqueue request originated.
- Queue
Task Status - Lifecycle of one scheduler queue row.
- Runner
Family - The GitHub Actions runner pool a CI target builds on.
- Task
Lane - Which scheduler lane a queue row belongs to.
Constants§
- CI_
TARGET_ TRIPLES - The compilation target triples the trusted CI build fleet covers.
Functions§
- is_
ci_ target - Whether trusted CI has a runner that can build this target.
- runner_
family - Which runner family
build-crate.ymldispatches this target to, orNonefor a target itsruns-onmap does not name.