Skip to main content

Crate scc_api

Crate scc_api 

Source
Expand description

SCC versioned request/response contracts.

Thin by design: result types ARE the canonical engine types (re-exported, never re-modelled), and request types are the exact argument tuples every transport already passes to the builders. Serialization is the only difference between transports — never semantic content. (JsonSchema derives arrive with the schemars dependency; adding a derive never changes the JSON wire shape.)

Structs§

ContextPack
DetailRequest
DiffRequest
ExportRequest
ImpactRequest
IndexPathsRequest
ModelIdentity
OperationResponse
QueryRequest
QuotaEntry
RankFeatures
RankItem
RankRequest
RankResult
RankedEntry
SelectionRequest
SnapshotSaveRequest
StartupRequest
StructuralRequest
SurfaceRenderResult
The production surface render: the budget-selected subset plus honest omission accounting (Wave 14F). rendered_ids are exactly the entries the agent sees (ledger recording MUST use only these — omitted candidates are never marked visible); omitted_ids are every candidate the pipeline cut. omissions summarizes the cuts by kind.
SurfaceRequest
SurfaceStages
Per-stage toggles for surface.build (all default true).
SystemAtlas
The full System Atlas: structured architecture before rendering. This is the machine model handed to agents at session start (docs/SYSTEM_DESIGN.md §8, Wave 2).
SystemIr
SystemSurfaceMap
The System Surface Map: the ranked actual-API layer of a repository, built from System IR (Level 1 of the context stack).
TaskContextRequest
TraverseRequest
TraverseStep
Serializable multi-step graph traversal (§16): start entities resolved by kind + name substring, then each step walks out / in / both edges (optional predicate filter, optional kind filter on the landing entity). Pure JSON — the fluent builder lives in SDKs, this AST is the wire contract every transport shares.

Constants§

API_VERSION
The current operation API version.
PLUGIN_API_VERSION
SCC plugin API compatibility version.

Type Aliases§

ApiVersion
Operation API version negotiated per request.