Struct Api 

pub struct Api { /* private fields */ }

Everything the routes need.

Implementations

impl Api

pub const DEFAULT_LIMIT: usize = 100

Default worklist page size.

pub const DEFAULT_HISTORY_LIMIT: usize = 200

Default bound on how much of a matter’s history one case view returns.

Bounded because a case can run for months and an operator page is not a bulk export. The response says when it truncated, because a shortened list is shaped exactly like a complete one and a reader who cannot tell will read absence as evidence.

pub fn new( planes: impl Into<Planes>, auth: Arc<dyn Authenticator>, ) -> Result<Self, ApiSetupError>

Build the surface over one plane, or several.

Takes anything that becomes Planes, so a single-tenant deployment still passes its runtime and reads the same as before.

Errors

ApiSetupError::NoPolicy if any plane has no policy engine — one ungoverned tenant among governed ones is the one an attacker looks for. ApiSetupError::NoPlanes if none was registered, which would serve nobody while starting cleanly.

pub const fn limit(self, limit: usize) -> Self

How many entries one listing page returns.

Every listing reads one past this and truncates, so there is more is a fact rather than an inference from a full page. The read is saturating: a ceiling set at the type’s own maximum would otherwise wrap the request to zero, and a backlog that answers empty is the one failure a listing must not have.

pub const fn history_limit(self, limit: usize) -> Self

How much history one view returns — a matter’s, or a run’s.

Its own knob rather than limit, because the two bound different readings: a list page is scanned, a history is followed — and an operator who widens the worklist page should not silently deepen every case view with it.

One knob for both histories rather than two, because they are the same reading: a page of records a caller continues from a cursor. A run’s is the one that keeps going — ?from=<seq> picks up where the last page stopped — while a matter’s is bounded by the matter.

pub fn router(self) -> Router

The router.

Every route authenticates and then authorizes. There is no unauthenticated one to forget about and no “internal” path that skips either gate — tests/wire/api.rs walks the route table and asserts it.

The routes are openapi::ROUTES, the table the published document is generated from, so a route is added in one place and is documented by being served.

Trait Implementations

impl Clone for Api

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Api

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.