Expand description
JSON-RPC 2.0 types. Handshake is camelCase; issue payloads are snake_case.
Structs§
- Agenda
Params issue/agendaparams. Defaultdaysis 14.- Claim
Params issue/claimparams.forcedefaults to false.- Claims
Params issue/claimsparams.- Create
Params issue/createparams. Fields match the CLI create verb.- Event
- One entry in the on-disk change log. One entry in the change log.
- Events
GenResult events/genresult.- Events
Since Params events/sinceparams.- Events
Since Result - Pull of the on-disk event log.
- IdParams
- Single issue id.
- Identity
Result identity/getresult.- Initialize
Params initializeparams. camelCase on the wire.- Initialize
Result initializeresult. camelCase on the wire.- Issue
GetResult - One issue plus the serve revision.
- Issue
List Params - Filters for
issue/listandissue/ready. snake_case on the wire. - Issue
List Result - Page of issue rows, or an unchanged marker.
- Issue
Selected issue/selectedparams. Broadcast afterissue/open.- Json
RpcError - JSON-RPC error object. Application codes carry
data.code. - Json
RpcRequest - JSON-RPC 2.0 request or notification envelope.
- Json
RpcResponse - JSON-RPC 2.0 response envelope.
- MutResult
- Mutation result shared by create, update, claim, note, and refile.
- Note
Params issue/noteparams.- Project
List Result project/listresult.- Refile
Params issue/refileparams.- Related
Params issue/relatedparams. Defaultdepthis 2 andlimitis 20.- Search
Params issue/searchparams. Defaultlimitis 20.- Tree
Params issue/treeparams.formatisnodes,ascii, ordot.- Update
Params issue/updateparams.- Vault
Changed vault/changedparams. Broadcast after a catalog rebuild.- Walk
Params - Params for children, ancestors, impact, and backlinks.
Enums§
- Error
- Wire-level failure for a control client or dispatcher.
- Json
RpcId - JSON-RPC request or notification id.
- Method
- v1 methods the owner advertises on
initialize. - Notification
- Push notifications. No
idon the wire. - Request
- Typed v1 request.
- Response
- Typed v1 result body.
- Tree
Result issue/treeresult: 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).initializeitself is omitted.
Functions§
- error_
from_ core - Map a typed core error onto the control-plane codes.
- internal_
error -32603internal error withmessage.- invalid_
params -32602invalid params withmessage.- invalid_
request -32600invalid request.- method_
not_ found -32601method not found.data.methodismethod.- parse_
error -32700parse error.- parse_
initialize_ params - Parse
initializeparams. Missing/emptyagentand version != 1 are -32602.