Skip to main content

Module types

Module types 

Source
Expand description

Shared request/response types for the ZeroClaw RPC + gateway API surface.

Single source of truth. Every domain’s wire types live here. The RPC dispatcher, the HTTP gateway, and the TUI client all import from this module. No ad-hoc json!(), no duplicated structs.

§Conventions

  • All structs derive Debug, Clone, Serialize, Deserialize.
  • All structs use #[serde(rename_all = "snake_case")].
  • Optional fields use #[serde(default, skip_serializing_if = "Option::is_none")].
  • Types that already exist elsewhere (MemoryEntry, CronJob, CostSummary, SkillFrontmatter) are re-exported, not re-defined.

Re-exports§

pub use crate::cron::CronJob;
pub use crate::cron::CronJobPatch;
pub use crate::cron::CronRun;
pub use crate::cron::DeliveryConfig;
pub use crate::cron::Schedule;
pub use crate::rpc::session::SessionOverrides;
pub use crate::skills::frontmatter::SkillFrontmatter;
pub use crate::quickstart::AppliedAgent;
pub use crate::quickstart::FieldDescriptor;
pub use crate::quickstart::FieldSection;
pub use crate::quickstart::QuickstartError;
pub use crate::quickstart::QuickstartStep;
pub use crate::quickstart::Surface;

Structs§

AgentEntry
AgentStatusEntry
AgentsListResult
AgentsStatusResult
BuilderSubmission
The complete Quickstart submission both surfaces hand to zeroclaw-runtime::quickstart::apply (and pre-validate via validate_only). Single source of truth; assembling config outside this type is a layering bug.
CatalogModelProvider
Consolidates gateway CatalogModelProvider.
CatalogModelsParams
CatalogModelsResult
Consolidates gateway ModelsResponse.
CatalogResponse
Consolidates gateway CatalogResponse.
ConfigDeleteParams
ConfigDeleteResult
ConfigFieldEntry
Serializable wire representation of a config field for API consumers (RPC dispatch, gateway, TUI). Single source of truth — replaces the gateway’s local ListEntry and the RPC dispatch’s ad-hoc JSON.
ConfigGetParams
ConfigGetPropResult
Returned when config/get is called with a specific prop.
ConfigListParams
ConfigListResult
ConfigMapKeyCreateParams
ConfigMapKeyCreateResult
ConfigMapKeyDeleteParams
ConfigMapKeyDeleteResult
ConfigMapKeyRenameParams
ConfigMapKeyRenameResult
ConfigMapKeysParams
ConfigMapKeysResult
ConfigReloadResult
ConfigSectionEntry
A config section entry for the dashboard sidebar / TUI section list.
ConfigSectionsResult
Response for config/sections.
ConfigSetParams
Value is polymorphic: a JSON string passes through as-is (backward compat); any other JSON type is coerced via coerce_for_set_prop.
ConfigSetResult
ConfigStatusResult
Config readiness status for the dashboard/TUI.
ConfigTemplateEntry
Owned wire representation of a zeroclaw_config::traits::MapKeySection. The upstream type uses &'static str fields that can’t round-trip through Deserialize, so this owned copy serves as the wire format.
ConfigTemplatesResult
ConfigValidateResult
CostQueryParams
Params for cost/query. Consolidates gateway CostQuery.
CostSummary
Cost summary for reporting.
CronAddParams
Params for cron/add. Consolidates gateway CronAddBody.
CronDeleteResult
CronIdParams
CronListResult
CronPatchParams
Params for cron/patch. Consolidates gateway CronPatchBody.
CronRunsParams
CronRunsResult
CronTriggerResult
FileAttachParams
FileAttachResult
FileEntry
A single file entry in a file/attach request. Either path (daemon reads from local disk — Unix socket only) or data_b64 (client sends base64-encoded bytes) must be present.
FileEntryResult
Result for a single file in a file/attach response.
InitializeParams
InitializeResult
LogsGetParams
logs/get params — fetch a single event by id.
LogsGetResult
logs/get result. event is the full LogEvent payload (attributes, attribution map, span ids, …) that the Logs pane only renders inside the detail modal — list rows store preview-only data.
LogsQueryParams
LogsQueryResult
LogsSubscribeResult
MemoryDeleteParams
Params for memory/delete. Consolidates gateway MemoryDeleteQuery.
MemoryDeleteResult
MemoryEntry
A single memory entry
MemoryGetParams
memory/get params — fetch one entry’s full content by key.
MemoryGetResult
memory/get result. entry carries the full content the Memory pane only renders inside the detail modal — list rows store preview-only data.
MemoryListParams
Params for memory/list. Consolidates gateway MemoryQuery (list mode).
MemoryListResult
MemorySearchParams
Params for memory/search. Consolidates gateway MemoryQuery (search mode).
MemorySearchResult
MemoryStoreParams
Params for memory/store. Consolidates gateway MemoryStoreBody.
MemoryStoreResult
MessageEntry
PersonalityFileEntry
Consolidates gateway PersonalityIndexEntry.
PersonalityGetParams
PersonalityGetResult
Consolidates gateway PersonalityFileResponse.
PersonalityListParams
PersonalityListResult
Consolidates gateway PersonalityIndex.
PersonalityPutParams
PersonalityPutResult
Consolidates gateway PersonalityPutResponse.
PersonalityTemplatesParams
PersonalityTemplatesResult
Consolidates gateway TemplateResponse.
PickerItem
Consolidates gateway PickerItem.
PickerResponse
Consolidates gateway PickerResponse.
QuickstartApplyParams
QuickstartDismissParams
QuickstartDismissResult
QuickstartFieldsParams
QuickstartFieldsResult
QuickstartStateResult
Mirrors zeroclaw_gateway::api_quickstart::QuickstartState.
QuickstartTypeOption
One row in the Quickstart “Create new …” picker. The TUI and web surfaces both render this list as-is — no hardcoded option lists on either side.
QuickstartValidateParams
SectionSelectParams
SelectItemResponse
Consolidates gateway SelectItemResponse.
SessionApproveParams
SessionApproveResult
SessionCancelResult
SessionCloseResult
SessionConfigureParams
SessionConfigureResult
SessionDeleteResult
SessionEntry
SessionGitBranchResult
SessionIdParams
Shared param for methods that only need a session ID: session/close, session/cancel, session/messages, session/state, session/delete.
SessionKillParams
SessionKillResult
SessionListParams
SessionListResult
SessionMessagesParams
Params for session/messages. limit + before_index page-window the load so a long session doesn’t slurp every message into client memory at once. Both default to the legacy “load everything” behaviour for callers that pre-date the pagination change.
SessionMessagesResult
SessionNewParams
SessionNewResult
SessionPromptParams
SessionPromptResult
SessionStateResult
SkillBundleEntry
Wire representation of a skill bundle. Consolidates gateway BundleEntry.
SkillListEntry
Wire representation of a skill in a list. Consolidates gateway SkillEntry.
SkillsBundlesResult
SkillsDeleteParams
SkillsDeleteResult
SkillsListParams
SkillsListResult
SkillsReadParams
SkillsReadResult
Consolidates gateway SkillReadResponse.
SkillsWriteParams
SkillsWriteResult
StatusResult
TemplateFileEntry
Consolidates gateway TemplateFile.
TuiListEntry
TuiListResult

Enums§

ChatMode
FileSource
Source hint for how the client obtained the file.
MemoryCategory
Memory categories for organization
PropKind
Runtime type classification for config property values.
QuickstartApplyResult
Tagged enum — matches the HTTP route’s ApplyResult shape.
QuickstartValidateResult
Tagged enum — matches the HTTP route’s ValidateResult shape so the drift test can compare bytes.
SessionUpdateEvent
Typed session update events pushed via session/update notifications. Replaces the hand-built notification_for_turn_event function.
TurnCompletionOutcome
Wire-stable subset of crate::rpc::turn::TurnOutcome for TurnComplete. messages is intentionally not on the wire — the TUI rebuilds from streamed chunks.