Skip to main content

Module rpc

Module rpc 

Source
Expand description

JSON-RPC 2.0 types. Handshake is camelCase; issue payloads are snake_case.

Structs§

AgendaParams
issue/agenda params. Default days is 14.
ClaimParams
issue/claim params. force defaults to false.
ClaimsParams
issue/claims params.
CreateParams
issue/create params. Fields match the CLI create verb.
Event
One entry in the on-disk change log. One entry in the change log.
EventsGenResult
events/gen result.
EventsSinceParams
events/since params.
EventsSinceResult
Pull of the on-disk event log.
IdParams
Single issue id.
IdentityResult
identity/get result.
InitializeParams
initialize params. camelCase on the wire.
InitializeResult
initialize result. camelCase on the wire.
IssueGetResult
One issue plus the serve revision.
IssueListParams
Filters for issue/list and issue/ready. snake_case on the wire.
IssueListResult
Page of issue rows, or an unchanged marker.
IssueSelected
issue/selected params. Broadcast after issue/open.
JsonRpcError
JSON-RPC error object. Application codes carry data.code.
JsonRpcRequest
JSON-RPC 2.0 request or notification envelope.
JsonRpcResponse
JSON-RPC 2.0 response envelope.
MutResult
Mutation result shared by create, update, claim, note, and refile.
NoteParams
issue/note params.
ProjectListResult
project/list result.
RefileParams
issue/refile params.
RelatedParams
issue/related params. Default depth is 2 and limit is 20.
SearchParams
issue/search params. Default limit is 20.
TreeParams
issue/tree params. format is nodes, ascii, or dot.
UpdateParams
issue/update params.
VaultChanged
vault/changed params. Broadcast after a catalog rebuild.
WalkParams
Params for children, ancestors, impact, and backlinks.

Enums§

Error
Wire-level failure for a control client or dispatcher.
JsonRpcId
JSON-RPC request or notification id.
Method
v1 methods the owner advertises on initialize.
Notification
Push notifications. No id on the wire.
Request
Typed v1 request.
Response
Typed v1 result body.
TreeResult
issue/tree result: a node graph or rendered text.

Constants§

CONFLICT
Claim conflict (-32009).
CYCLE
Blocker cycle (-32022).
INTERNAL_ERROR
JSON-RPC internal error (-32603).
INVALID_PARAMS
JSON-RPC invalid params (-32602).
INVALID_REQUEST
JSON-RPC invalid request (-32600).
INVALID_STATE
Closed issue or invalid state (-32010).
METHOD_NOT_FOUND
JSON-RPC method not found (-32601).
NOTIFY_ISSUE_SELECTED
Shared selection. Params: IssueSelected.
NOTIFY_SHUTTING_DOWN
Owner is exiting. Params: {}.
NOTIFY_VAULT_CHANGED
Catalog rebuilt. Params: VaultChanged.
NOT_FOUND
Issue not found (-32004).
PARSE_ERROR
JSON-RPC parse error (-32700).
PROTOCOL_VERSION
Protocol version accepted by initialize.
V1_CAPABILITIES
Capability strings returned by initialize (v1). initialize itself is omitted.

Functions§

error_from_core
Map a typed core error onto the control-plane codes.
internal_error
-32603 internal error with message.
invalid_params
-32602 invalid params with message.
invalid_request
-32600 invalid request.
method_not_found
-32601 method not found. data.method is method.
parse_error
-32700 parse error.
parse_initialize_params
Parse initialize params. Missing/empty agent and version != 1 are -32602.