-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathsearch.yaml
More file actions
4838 lines (4810 loc) · 143 KB
/
Copy pathsearch.yaml
File metadata and controls
4838 lines (4810 loc) · 143 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Generated by `devtools render openapi`. Do not edit by hand.
# Source models: polylogue.surfaces.payloads query envelopes and polylogue.daemon.web_auth.
openapi: 3.1.0
info:
title: Polylogue Search API
version: '1'
description: Local daemon HTTP API exposing typed query envelopes shared across CLI JSON, MCP, and the Python API. This
document is generated from Pydantic models in `polylogue.surfaces.payloads` and `polylogue.daemon.web_auth`; do not edit
by hand. Run `devtools render openapi` to regenerate.
servers:
- url: http://127.0.0.1:{port}
description: Local Polylogue daemon (loopback only).
variables:
port:
default: '8765'
description: Daemon HTTP port; see `polylogued status`.
paths:
/api/web-auth/session:
post:
summary: Bootstrap or rotate a first-party web credential
description: Loopback, exact-origin browser bootstrap. The opaque credential is returned only in an HttpOnly SameSite=Strict
cookie; the JSON body contains lifecycle metadata, scopes, and expiry but never credential bytes.
operationId: bootstrapWebCredential
security: []
responses:
'201':
description: Credential issued and protected cookie set.
headers:
Set-Cookie:
description: Protected HttpOnly first-party credential transport.
schema:
type: string
writeOnly: true
X-Polylogue-Web-Credential-State:
schema:
type: string
const: ready
content:
application/json:
schema:
$ref: '#/components/schemas/WebCredentialBootstrapPayload'
'400':
description: Credential-shaped query parameters are forbidden.
content:
application/json:
schema:
$ref: '#/components/schemas/QueryErrorPayload'
'403':
description: Bootstrap origin was not the daemon's authority.
headers:
X-Polylogue-Web-Credential-State:
schema:
type: string
enum: &id001
- web_credential_missing
- web_credential_invalid
- web_credential_expired
- web_credential_revoked
- web_credential_wrong_origin
- web_credential_insufficient_scope
content:
application/json:
schema:
$ref: '#/components/schemas/WebCredentialFailurePayload'
x-polylogue-recoverable-states: *id001
delete:
summary: Revoke the current first-party web credential
operationId: revokeWebCredential
security:
- webCredentialCookie: []
responses:
'200':
description: Credential revoked and browser cookie expired.
headers:
Set-Cookie:
description: Expires the protected first-party credential cookie.
schema:
type: string
writeOnly: true
X-Polylogue-Web-Credential-State:
schema:
type: string
const: web_credential_revoked
content:
application/json:
schema:
$ref: '#/components/schemas/WebCredentialRevocationPayload'
'400':
description: Credential-shaped query parameters are forbidden.
content:
application/json:
schema:
$ref: '#/components/schemas/QueryErrorPayload'
'401':
description: Credential is missing, invalid, expired, or revoked.
headers:
X-Polylogue-Web-Credential-State:
schema:
type: string
enum: *id001
content:
application/json:
schema:
$ref: '#/components/schemas/WebCredentialFailurePayload'
'403':
description: Credential origin or scope is not admitted.
headers:
X-Polylogue-Web-Credential-State:
schema:
type: string
enum: *id001
content:
application/json:
schema:
$ref: '#/components/schemas/WebCredentialFailurePayload'
x-polylogue-recoverable-states: *id001
/api/sessions:
get:
summary: Ranked session search and list
description: When ``query`` is supplied, returns a ranked search envelope (``SearchEnvelope``) with per-hit match evidence
and pagination handles. When ``query`` is omitted, returns ``SessionListResponse``. Ranked search exposes the opaque
``next_cursor`` handle; the current list mode remains offset-based.
operationId: searchSessions
security:
- machineBearer: []
- webCredentialCookie: []
parameters:
- name: query
in: query
description: FTS5 search query string.
required: false
schema:
type: string
- name: limit
in: query
description: Page size (default 50).
required: false
schema:
type: integer
minimum: 1
default: 50
- name: offset
in: query
description: Row offset. Best-effort for ranked search; use ``next_cursor`` for stable pagination.
required: false
schema:
type: integer
minimum: 0
default: 0
- name: provider
in: query
description: Provider name filter.
required: false
schema:
type: string
- name: since
in: query
description: ISO 8601 lower bound on session date.
required: false
schema:
type: string
format: date-time
- name: retrieval_lane
in: query
description: 'Retrieval lane: ``auto``, ``dialogue``, ``actions``, ``hybrid``, ``semantic``.'
required: false
schema:
type: string
enum:
- auto
- dialogue
- actions
- hybrid
- semantic
default: auto
- name: cursor
in: query
description: Opaque keyset cursor previously returned as ``next_cursor`` on a search response. Stable across archive
growth and daemon restart (#1268). MUST be passed back unchanged. Rejected with 400 when malformed or when the retrieval
lane no longer matches.
required: false
schema:
type: string
responses:
'200':
description: Ranked search envelope (when ``query`` is supplied) or session list envelope.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/SearchEnvelope'
- $ref: '#/components/schemas/SessionListResponse'
'400':
description: Malformed query or credential-shaped query parameter.
content:
application/json:
schema:
$ref: '#/components/schemas/QueryErrorPayload'
'401':
description: Machine bearer or web credential was not accepted.
headers:
X-Polylogue-Web-Credential-State:
description: Present when the first-party web credential was evaluated.
schema:
type: string
enum: *id001
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/QueryErrorPayload'
- $ref: '#/components/schemas/WebCredentialFailurePayload'
'403':
description: Host, origin, or web credential scope was not admitted.
headers:
X-Polylogue-Web-Credential-State:
description: Present when the first-party web credential was evaluated.
schema:
type: string
enum: *id001
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/QueryErrorPayload'
- $ref: '#/components/schemas/WebCredentialFailurePayload'
x-polylogue-page:
iterator: search
initial_required_parameters:
- query
response_schemas:
- SearchEnvelope
items_property: hits
cursor_property: next_cursor
cursor_parameter: cursor
continuation_request: merge
reset_parameters:
- offset
coverage:
total_property: total
exactness_property: exactness
exact_values:
- exact
default_exact: true
qualified_values:
- capped
- sampled
- estimate
/api/query-units:
get:
summary: Terminal query-unit rows
description: Returns terminal row results for explicit ``messages/actions/blocks/assertions/files/runs/observed-events/context-snapshots/delegations
where ...`` expressions. This endpoint shares the query-unit row and aggregate envelope contracts with CLI JSON output,
MCP ``query_units``, and ``Polylogue.query_units()``.
operationId: queryUnits
security:
- machineBearer: []
- webCredentialCookie: []
parameters:
- name: expression
in: query
description: 'Explicit unit-source expression for the first page. Omit it when passing an opaque ``continuation``.
Examples: ``messages where session.repo:polylogue AND role:assistant AND text:timeout``; ``actions where session.repo:polylogue
AND tool:bash AND text:pytest``; ``blocks where session.origin:codex-session AND type:code AND text:timeout``; ``assertions
where kind:decision AND status:active AND text:review``; ``files where session.repo:polylogue AND action:file_edit
AND path:archive/query``; ``runs where session.repo:polylogue AND role:main``; ``observed-events where kind:tool_finished
AND status:failed | group by tool | count``; ``context-snapshots where boundary:session_start``; ``delegations where
mapping_state:resolved AND instruction:review``.'
required: false
schema:
type: string
- name: continuation
in: query
description: Opaque QueryTransaction continuation returned by the previous page. Pass it back unchanged and without
any other query parameters.
required: false
schema:
type: string
- name: limit
in: query
description: Page size (default 50).
required: false
schema:
type: integer
minimum: 1
default: 50
- name: offset
in: query
description: Row offset for terminal query-unit pagination.
required: false
schema:
type: integer
minimum: 0
default: 0
- name: origin
in: query
description: Optional session-origin scope for terminal row results.
required: false
schema:
type: string
- name: tag
in: query
description: Optional session tag scope for terminal row results.
required: false
schema:
type: string
- name: exclude_tag
in: query
description: Optional comma-separated session tags to exclude from terminal row results.
required: false
schema:
type: string
- name: repo
in: query
description: Optional comma-separated repo-name scope for terminal row results.
required: false
schema:
type: string
- name: has_type
in: query
description: Optional comma-separated block types required on the containing session.
required: false
schema:
type: string
- name: referenced_path
in: query
description: Optional comma-separated referenced paths required on the containing session.
required: false
schema:
type: string
- name: cwd_prefix
in: query
description: Optional working-directory prefix required on the containing session.
required: false
schema:
type: string
- name: tool
in: query
description: Optional comma-separated tool names required on the containing session.
required: false
schema:
type: string
- name: exclude_tool
in: query
description: Optional comma-separated tool names excluded from the containing session.
required: false
schema:
type: string
- name: action
in: query
description: Optional comma-separated action kinds required on the containing session.
required: false
schema:
type: string
- name: exclude_action
in: query
description: Optional comma-separated action kinds excluded from the containing session.
required: false
schema:
type: string
- name: action_sequence
in: query
description: Optional action sequence required on the containing session.
required: false
schema:
type: string
- name: action_text
in: query
description: Optional action text required on the containing session.
required: false
schema:
type: string
- name: title
in: query
description: Optional session-title substring scope for terminal row results.
required: false
schema:
type: string
- name: since
in: query
description: Optional session lower time bound, using the shared query date parser.
required: false
schema:
type: string
- name: until
in: query
description: Optional session upper time bound, using the shared query date parser.
required: false
schema:
type: string
- name: has_tool_use
in: query
description: Restrict terminal rows to sessions with tool-use evidence.
required: false
schema:
type: boolean
default: false
- name: has_paste_evidence
in: query
description: Restrict terminal rows to sessions with paste evidence.
required: false
schema:
type: boolean
default: false
- name: has_thinking
in: query
description: Restrict terminal rows to sessions with thinking blocks.
required: false
schema:
type: boolean
default: false
- name: typed_only
in: query
description: Restrict terminal rows to typed sessions without paste evidence.
required: false
schema:
type: boolean
default: false
- name: min_messages
in: query
description: Restrict terminal rows to sessions with at least this many messages.
required: false
schema:
type: integer
minimum: 0
- name: max_messages
in: query
description: Restrict terminal rows to sessions with at most this many messages.
required: false
schema:
type: integer
minimum: 0
- name: min_words
in: query
description: Restrict terminal rows to sessions with at least this many words.
required: false
schema:
type: integer
minimum: 0
- name: max_words
in: query
description: Restrict terminal rows to sessions with at most this many words.
required: false
schema:
type: integer
minimum: 0
- name: message_type
in: query
description: Restrict terminal rows by session message-type evidence.
required: false
schema:
type: string
responses:
'200':
description: Terminal query-unit row or aggregate result envelope.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/QueryUnitEnvelope'
- $ref: '#/components/schemas/QueryUnitAggregateEnvelope'
'400':
description: Malformed query or non-terminal session expression.
content:
application/json:
schema:
$ref: '#/components/schemas/QueryErrorPayload'
'401':
description: Machine bearer or web credential was not accepted.
headers:
X-Polylogue-Web-Credential-State:
description: Present when the first-party web credential was evaluated.
schema:
type: string
enum: *id001
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/QueryErrorPayload'
- $ref: '#/components/schemas/WebCredentialFailurePayload'
'403':
description: Host, origin, or web credential scope was not admitted.
headers:
X-Polylogue-Web-Credential-State:
description: Present when the first-party web credential was evaluated.
schema:
type: string
enum: *id001
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/QueryErrorPayload'
- $ref: '#/components/schemas/WebCredentialFailurePayload'
x-polylogue-page:
iterator: query
initial_required_parameters:
- expression
response_schemas:
- QueryUnitEnvelope
- QueryUnitAggregateEnvelope
items_property: items
cursor_property: continuation
cursor_parameter: continuation
continuation_request: cursor_only
query_ref_property: query_ref
result_ref_property: result_ref
coverage:
total_property: total
kind: qualified
qualification: page
/api/sessions/{session_id}/read:
get:
summary: Execute a session read-view
description: Executes one supported single-session read profile and returns the stable ``SessionReadViewEnvelope``.
Supported profiles currently include ``messages``, ``raw``, ``context``, ``context-image``, ``neighbors``, ``correlation``.
The envelope shape is stable; individual ``payload`` content is the shared DTO for the selected read profile.
operationId: readSessionView
security:
- machineBearer: []
- webCredentialCookie: []
parameters:
- name: session_id
in: path
description: Resolved Polylogue session id.
required: true
schema:
type: string
- name: view
in: query
description: Read-view id from /api/read-view-profiles.
required: false
schema:
type: string
enum:
- messages
- raw
- context
- context-image
- neighbors
- correlation
default: messages
- name: format
in: query
description: Output format accepted by the selected read view.
required: false
schema:
type: string
enum:
- json
default: json
- name: limit
in: query
required: false
description: Messages/neighbor page size where applicable.
schema:
type: integer
minimum: 1
- name: offset
in: query
required: false
description: Message offset for the messages view.
schema:
type: integer
minimum: 0
- name: related_limit
in: query
required: false
description: Number of related sessions to include in the context view.
schema:
type: integer
minimum: 1
default: 5
- name: include_messages
in: query
required: false
description: Include message excerpts in context-image payloads.
schema:
type: boolean
default: true
- name: max_tokens
in: query
required: false
description: Token budget for the compiled context image; over-budget segments are omitted.
schema:
type: integer
minimum: 1
- name: no_redact
in: query
required: false
description: Return unredacted context-image path/provenance details where available.
schema:
type: boolean
default: false
- name: window_hours
in: query
required: false
description: Neighbor discovery window in hours.
schema:
type: integer
minimum: 1
default: 24
- name: confidence_threshold
in: query
required: false
description: Minimum confidence for correlation evidence.
schema:
type: number
minimum: 0
maximum: 1
default: 0.3
- name: repo_path
in: query
required: false
description: Repository path for correlation evidence.
schema:
type: string
- name: since_hours
in: query
required: false
description: Correlation scan window on each side of the session.
schema:
type: integer
minimum: 1
default: 2
responses:
'200':
description: Executed read-view envelope.
content:
application/json:
schema:
$ref: '#/components/schemas/SessionReadViewEnvelope'
'400':
description: Unsupported view/format or credential-shaped query parameter.
content:
application/json:
schema:
$ref: '#/components/schemas/QueryErrorPayload'
'404':
description: Session not found.
'401':
description: Machine bearer or web credential was not accepted.
headers:
X-Polylogue-Web-Credential-State:
description: Present when the first-party web credential was evaluated.
schema:
type: string
enum: *id001
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/QueryErrorPayload'
- $ref: '#/components/schemas/WebCredentialFailurePayload'
'403':
description: Host, origin, or web credential scope was not admitted.
headers:
X-Polylogue-Web-Credential-State:
description: Present when the first-party web credential was evaluated.
schema:
type: string
enum: *id001
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/QueryErrorPayload'
- $ref: '#/components/schemas/WebCredentialFailurePayload'
/api/assertions:
get:
summary: List assertion-backed overlay claims
description: Returns assertion claims through the stable ``AssertionClaimListPayload`` shared by the web workbench,
Python API, and MCP assertion-read surface. Defaults to active and candidate claims; use ``status=all`` for an explicit
full lifecycle read.
operationId: listAssertionClaims
security:
- machineBearer: []
- webCredentialCookie: []
parameters:
- name: target_ref
in: query
description: Optional target object ref, such as ``session:<id>``.
required: false
schema:
type: string
- name: scope_ref
in: query
description: Optional assertion scope object ref, such as ``repo:polylogue``.
required: false
schema:
type: string
- name: kind
in: query
description: Assertion kind filter. May be repeated or comma-separated.
required: false
schema:
type: string
- name: status
in: query
description: Lifecycle status filter. Defaults to active,candidate; ``all`` includes every persisted status.
required: false
schema:
type: string
- name: context_inject
in: query
description: Restrict by assertion context_policy.inject.
required: false
schema:
type: boolean
- name: limit
in: query
description: Maximum claims returned.
required: false
schema:
type: integer
minimum: 1
default: 50
responses:
'200':
description: Assertion claim list envelope.
content:
application/json:
schema:
$ref: '#/components/schemas/AssertionClaimListPayload'
'400':
description: Malformed or credential-shaped query parameter.
content:
application/json:
schema:
$ref: '#/components/schemas/QueryErrorPayload'
'401':
description: Machine bearer or web credential was not accepted.
headers:
X-Polylogue-Web-Credential-State:
description: Present when the first-party web credential was evaluated.
schema:
type: string
enum: *id001
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/QueryErrorPayload'
- $ref: '#/components/schemas/WebCredentialFailurePayload'
'403':
description: Host, origin, or web credential scope was not admitted.
headers:
X-Polylogue-Web-Credential-State:
description: Present when the first-party web credential was evaluated.
schema:
type: string
enum: *id001
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/QueryErrorPayload'
- $ref: '#/components/schemas/WebCredentialFailurePayload'
components:
schemas:
ActionAffordancePayload:
additionalProperties: false
description: Shared static action-affordance contract for public action surfaces.
properties:
id:
title: Id
type: string
path:
items:
type: string
title: Path
type: array
effect:
enum:
- read
- write
- destructive
- stream
- ops
- config
- import
title: Effect
type: string
target:
enum:
- none
- selection
- session
- path
- config
- runtime
- candidate
title: Target
type: string
input:
$ref: '#/components/schemas/ActionInputPayload'
execution:
$ref: '#/components/schemas/ActionExecutionPayload'
output:
$ref: '#/components/schemas/ActionOutputPayload'
safety:
$ref: '#/components/schemas/ActionSafetyPayload'
availability:
$ref: '#/components/schemas/ActionAvailabilityPayload'
required:
- id
- path
- effect
- target
- input
- execution
- output
- safety
- availability
title: ActionAffordancePayload
type: object
ActionAvailabilityPayload:
additionalProperties: false
description: Availability and next-action posture for an affordance.
properties:
disabled_reason:
anyOf:
- type: string
- type: 'null'
default: null
title: Disabled Reason
estimated_cost:
anyOf:
- type: string
- type: 'null'
default: null
title: Estimated Cost
next_actions:
default: []
items:
type: string
title: Next Actions
type: array
title: ActionAvailabilityPayload
type: object
ActionExecutionPayload:
additionalProperties: false
description: Execution constraints for an affordance before the action runs.
properties:
cardinality_state:
enum:
- any
- singleton
- explicit_multi
- destructive_multi
title: Cardinality State
type: string
guards:
default: []
items:
type: string
title: Guards
type: array
requires_daemon:
title: Requires Daemon
type: boolean
required:
- cardinality_state
- requires_daemon
title: ActionExecutionPayload
type: object
ActionInputPayload:
additionalProperties: false
description: Input side of an action affordance. Keeps selection/query input explicit.
properties:
unit:
enum:
- none
- query_result_set
- session
- path
- config
- runtime
- assertion_candidate
title: Unit
type: string
completion_context:
anyOf:
- enum:
- config_key
- filesystem_path
- query_expression
- session_id
type: string
- type: 'null'
default: null
title: Completion Context
required:
- unit
title: ActionInputPayload
type: object
ActionOutputPayload:
additionalProperties: false
description: Output contract for an affordance.
properties:
destination_support:
items:
enum:
- terminal
- stdout
- browser
- clipboard
- file
- api
- mcp
type: string
title: Destination Support
type: array
format_support:
items:
enum:
- human
- json
- ndjson
type: string
title: Format Support
type: array
default_format:
enum:
- human
- json
- ndjson
title: Default Format
type: string
machine_envelope:
enum:
- result_set
- item
- mutation
- error
- stream_item
title: Machine Envelope
type: string
required:
- destination_support
- format_support
- default_format
- machine_envelope
title: ActionOutputPayload
type: object
ActionSafetyPayload:
additionalProperties: false
description: Safety and confirmation posture for an affordance.
properties:
safety_level:
enum:
- safe
- mutating
- destructive
- operational
title: Safety Level
type: string
confirmation_command:
anyOf:
- type: string
- type: 'null'
default: null
title: Confirmation Command
selection_command:
anyOf:
- type: string
- type: 'null'
default: null
title: Selection Command
required:
- safety_level
title: ActionSafetyPayload
type: object
QueryMissDiagnosticsPayload:
additionalProperties: false
description: Shared diagnostics payload for zero-result queries.
properties:
message:
title: Message
type: string
filters:
items:
type: string
title: Filters
type: array
reasons:
items:
$ref: '#/components/schemas/QueryMissReasonPayload'
title: Reasons
type: array
archive_session_count:
anyOf:
- type: integer
- type: 'null'
default: null
title: Archive Session Count
raw_session_count:
anyOf:
- type: integer