Repository navigation
Expand file tree
/
Copy pathapi-coverage.toml
More file actions
904 lines (744 loc) · 34 KB
/
Copy pathapi-coverage.toml
File metadata and controls
904 lines (744 loc) · 34 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
# Reviewed against the live public OpenAPI catalog by scripts/audit_api_coverage.py.
# Every published operation must either reach a first-class CLI command or have a reason here,
# every published request-body property on a covered operation must either be declared on
# the Rust request struct the CLI sends or have a reason in the request-field sections below,
# and every published header or query parameter on a covered operation must either be sendable
# by the CLI or have a reason in the parameter sections at the end of this file.
#
# Every known_gap, known_field_gap and known_parameter_gap entry records the date someone last
# reviewed it in reviewed_at. Once a gap is older than gap_review.max_age_days, the audit reports
# ACTION REQUIRED until the gap is implemented or reviewed again with a new reviewed_at date.
[snapshot]
catalog_url = "https://api.coval.dev/v1/openapi"
reviewed_at = "2026-11-06"
published_operations = 199
cli_supported_operations = 131
published_request_fields = 475
cli_modeled_request_fields = 474
published_parameters = 196
cli_supported_parameters = 144
[gap_review]
max_age_days = 120
[[allowed_extra]]
operation = "POST /test-cases/{test_case_id}/media:upload-url"
reason = "Implemented by the public API but currently omitted from its published OpenAPI specs."
# The original conversation commands remain available for scripts that use the
# earlier public route names. The primary CLI help and generated next actions use
# the canonical conversation commands and routes.
[[allowed_extra]]
operation = "GET /conversations"
reason = "Retained route for the legacy `coval conversations list` command."
[[allowed_extra]]
operation = "POST /conversations:submit"
reason = "Retained route for the legacy `coval conversations submit` command."
[[allowed_extra]]
operation = "GET /conversations/{id}"
reason = "Retained route for the legacy `coval conversations get` command."
[[allowed_extra]]
operation = "PATCH /conversations/{id}"
reason = "Retained route for the legacy `coval conversations patch` command."
[[allowed_extra]]
operation = "DELETE /conversations/{id}"
reason = "Retained route for the legacy `coval conversations delete` command."
[[allowed_extra]]
operation = "GET /conversations/{id}/audio"
reason = "Retained route for the legacy `coval conversations audio` command."
[[allowed_extra]]
operation = "GET /conversations/{id}/metrics"
reason = "Retained route for the legacy `coval conversations metrics` command."
[[allowed_extra]]
operation = "GET /conversations/{id}/metrics/{metric_path_id}"
reason = "Retained route for the legacy `coval conversations metric-detail` command."
[[allowed_extra]]
operation = "GET /simulations"
reason = "Retained route for the legacy `coval simulations list` command."
[[allowed_extra]]
operation = "GET /simulations/{id}"
reason = "Retained route for the legacy `coval simulations get` command."
[[allowed_extra]]
operation = "PATCH /simulations/{id}"
reason = "Retained route for the legacy `coval simulations update` command."
[[allowed_extra]]
operation = "DELETE /simulations/{id}"
reason = "Retained route for the legacy `coval simulations delete` command."
[[allowed_extra]]
operation = "GET /simulations/{id}/audio"
reason = "Retained route for the legacy `coval simulations audio` command."
[[allowed_extra]]
operation = "GET /simulations/{id}/metrics"
reason = "Retained route for the legacy `coval simulations metrics` command."
[[allowed_extra]]
operation = "GET /simulations/{id}/metrics/{metric_path_id}"
reason = "Retained route for the legacy `coval simulations metric-detail` command."
[[allowed_extra]]
operation = "POST /simulations/{id}/resimulate"
reason = "Retained route for the legacy `coval simulations resimulate` command."
# The public API renamed its published spec from monitors-v1 to alerts-v1 in
# coval-ai/backend#6368. The /v1/monitors routes were deliberately retained as a
# serving legacy alias rather than removed, so `coval monitors` is not broken.
# Verified against production on 2026-08-04: every /v1/monitors route below still
# reaches its Lambda and returns a Coval-shaped response, while an unrouted path
# returns API Gateway's own {"message":"Not Found"}. These entries keep the CLI's
# existing command surface reviewed until it moves to the canonical /v1/alerts
# paths; see the matching alerts known_gap entries below.
[[allowed_extra]]
operation = "GET /monitors"
reason = "Retained legacy alias for the published GET /alerts operation."
[[allowed_extra]]
operation = "POST /monitors"
reason = "Retained legacy alias for the published POST /alerts operation."
[[allowed_extra]]
operation = "GET /monitors/{id}"
reason = "Retained legacy alias for the published GET /alerts/{alert_id} operation."
[[allowed_extra]]
operation = "PATCH /monitors/{id}"
reason = "Retained legacy alias for the published PATCH /alerts/{alert_id} operation."
[[allowed_extra]]
operation = "DELETE /monitors/{id}"
reason = "Retained legacy alias for the published DELETE /alerts/{alert_id} operation."
[[allowed_extra]]
operation = "GET /monitors/{monitor_id}/events"
reason = "Retained legacy alias for the published GET /alerts/{alert_id}/events operation."
[[allowed_extra]]
operation = "POST /monitors/{monitor_id}/test-evaluate"
reason = "Retained legacy alias for the published POST /alerts/{alert_id}/test-evaluate operation."
[[known_gap]]
operation = "GET /agents/{agent_id}/versions"
reason = "Agent version history remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "POST /agents/{agent_id}/versions/{version_id}/revert"
reason = "Agent version rollback remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "POST /agents/{agent_id}/duplicate"
reason = "Agent duplication remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
# Alerts is the canonical published surface after coval-ai/backend#6368. The
# behaviour is already reachable from the CLI today via `coval monitors`, which
# calls the retained /v1/monitors legacy alias, so these are naming gaps rather
# than missing functionality. Closing them means pointing the CLI at the
# canonical /v1/alerts paths and renaming the command to `coval alerts` with
# `monitors` kept as an alias, which is a deliberate follow-up rather than part
# of this reconciliation.
[[known_gap]]
operation = "GET /alerts"
reason = "Served today by `coval monitors list` through the retained /v1/monitors alias; a first-class `coval alerts` surface is a follow-up."
reviewed_at = "2026-08-05"
[[known_gap]]
operation = "POST /alerts"
reason = "Served today by `coval monitors create` through the retained /v1/monitors alias; a first-class `coval alerts` surface is a follow-up."
reviewed_at = "2026-08-05"
[[known_gap]]
operation = "GET /alerts/{alert_id}"
reason = "Served today by `coval monitors get` through the retained /v1/monitors alias; a first-class `coval alerts` surface is a follow-up."
reviewed_at = "2026-08-05"
[[known_gap]]
operation = "PATCH /alerts/{alert_id}"
reason = "Served today by `coval monitors update` through the retained /v1/monitors alias; a first-class `coval alerts` surface is a follow-up."
reviewed_at = "2026-08-05"
[[known_gap]]
operation = "DELETE /alerts/{alert_id}"
reason = "Served today by `coval monitors delete` through the retained /v1/monitors alias; a first-class `coval alerts` surface is a follow-up."
reviewed_at = "2026-08-05"
[[known_gap]]
operation = "GET /alerts/{alert_id}/events"
reason = "Served today by `coval monitors events` through the retained /v1/monitors alias; a first-class `coval alerts` surface is a follow-up."
reviewed_at = "2026-08-05"
[[known_gap]]
operation = "POST /alerts/{alert_id}/test-evaluate"
reason = "Served today by `coval monitors test-evaluate` through the retained /v1/monitors alias; a first-class `coval alerts` surface is a follow-up."
reviewed_at = "2026-08-05"
[[known_gap]]
operation = "POST /audio:upload"
reason = "Generic audio upload has not yet been given a CLI file-upload workflow."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "GET /metrics/flows"
reason = "Metric-flow resources remain to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "POST /metrics/flows"
reason = "Metric-flow resources remain to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "PATCH /metrics/flows/{flow_id}"
reason = "Metric-flow resources remain to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "DELETE /metrics/flows/{flow_id}"
reason = "Metric-flow resources remain to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "GET /metrics/recently-deleted"
reason = "Metric restore discovery remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "POST /metrics/{metric_id}/restore"
reason = "Metric restore remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "GET /metrics/sql-schema"
reason = "SQL metric authoring helpers remain to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "POST /metrics/sql:test"
reason = "SQL metric authoring helpers remain to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "GET /metrics/tags"
reason = "Metric tag-value discovery remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "GET /metrics/template-variables"
reason = "Metric template-variable discovery remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "POST /metrics/outputs:batchGet"
reason = "Batch metric-output reads remain to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "GET /metrics/{metric_id}/baselines/{baseline_id}/history"
reason = "Metric baseline history remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "POST /metrics/{metric_id}/versions/{version_id}/revert"
reason = "Metric version rollback remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "GET /organization/conversation-metrics"
reason = "Organization monitoring configuration remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "PATCH /organization/conversation-metrics"
reason = "Organization monitoring configuration remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "GET /organization/monitoring-metrics"
reason = "Organization monitoring configuration remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "PATCH /organization/monitoring-metrics"
reason = "Organization monitoring configuration remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "GET /organization/users"
reason = "The organization user roster remains to be modeled under COVAL-2079."
reviewed_at = "2026-10-14"
[[known_gap]]
operation = "GET /personas/tags"
reason = "Persona tag-value discovery remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "GET /personas/{persona_id}/versions"
reason = "Persona version history remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "POST /personas/{persona_id}/versions/{version_id}/revert"
reason = "Persona version rollback remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "POST /personas/{persona_id}/duplicate"
reason = "Persona duplication remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "POST /review-annotations:withMetricOutputs"
reason = "Advanced review reads remain to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "GET /review-annotations/metric-health-stats"
reason = "Review analytics remain to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "GET /review-projects/{project_id}/insights"
reason = "Review analytics remain to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "GET /review-projects/{project_id}/metric-agreement"
reason = "Review analytics remain to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "GET /review-projects/{project_id}/progress"
reason = "Review analytics remain to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "POST /review-projects/disagreement-state"
reason = "Review analytics remain to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "GET /runs/tags"
reason = "Run tag-value discovery remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "GET /scheduled-runs/{scheduled_run_id}/runs"
reason = "Scheduled-run execution history remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "POST /conversations/simulated:rerunMetrics"
reason = "Batch metric reruns need a dedicated confirmation-aware CLI workflow."
reviewed_at = "2026-09-01"
[[known_gap]]
operation = "GET /simulations/{simulation_id}/attributes/{attribute_name}"
reason = "Named simulation-attribute reads remain to be modeled under COVAL-2079."
reviewed_at = "2026-10-14"
[[known_gap]]
operation = "GET /simulations/{simulation_id}/connect"
reason = "SDK WebSocket connection discovery is intentionally delegated to the Coval Agent SDK, which consumes its one-use relay token."
reviewed_at = "2026-10-14"
[[known_gap]]
operation = "GET /integrations/slack"
reason = "Slack integration lifecycle remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "POST /integrations/slack/connect"
reason = "Slack integration lifecycle remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "DELETE /integrations/slack"
reason = "Slack integration lifecycle remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "GET /test-sets/{test_set_id}/agents"
reason = "Test-set agent associations remain to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "POST /test-sets/{test_set_id}/agents:add"
reason = "Test-set agent associations remain to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "DELETE /test-sets/{test_set_id}/agents/{agent_id}"
reason = "Test-set agent associations remain to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "GET /test-sets/{test_set_id}/records"
reason = "Test-set record export remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "GET /test-sets/{test_set_id}/versions"
reason = "Test-set version history remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "POST /test-sets/{test_set_id}/versions/{version_id}/revert"
reason = "Test-set version rollback remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "POST /test-sets/{test_set_id}/duplicate"
reason = "Test-set duplication remains to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "POST /traces"
reason = "OTLP ingestion is intentionally delegated to OpenTelemetry SDKs rather than JSON CLI input."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "GET /webhooks"
reason = "Webhook resources remain to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "POST /webhooks"
reason = "Webhook resources remain to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "PATCH /webhooks/{webhook_id}"
reason = "Webhook resources remain to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "DELETE /webhooks/{webhook_id}"
reason = "Webhook resources remain to be modeled under COVAL-2079."
reviewed_at = "2026-07-30"
[[known_gap]]
operation = "POST /review-projects/{project_id}/complete-conversation"
reason = "Project-scoped completion remains to be modeled under COVAL-2079; this explicit write needs a deliberate command workflow rather than being exposed by the parity refresh."
reviewed_at = "2026-10-05"
[[known_gap]]
operation = "POST /sofia/delegation-token"
reason = "Customer API-key delegation token minting remains to be modeled under COVAL-2079 with an explicit security-sensitive CLI workflow."
reviewed_at = "2026-10-05"
# =============================================================================
# REQUEST FIELDS
# =============================================================================
#
# serde drops any JSON field a request struct does not declare, so a published
# request-body property missing from src/client/models/*.rs is discarded in
# silence. These sections review that layer for operations the CLI already
# implements; a published operation with no CLI command at all is a route gap
# above, not a field gap here.
#
# The published YAML is hand-written rather than generated, so it can be wrong in
# either direction. Before modeling a field, cross-check it against the served
# Pydantic model; coval-ai/backend records the known divergence in
# src/services/api/tests/v1/openapi_parity_baseline.txt.
# Fields the CLI sends that the published schema does not declare. Most are served
# but undocumented, so removing them from the CLI would lose working behavior.
[[allowed_extra_field]]
operation = "PATCH /conversations/uploaded/{conversation_id}"
field = "audio_reference"
reason = "Served but deliberately hidden from the published schema as an internal field; the API still accepts it."
[[allowed_extra_field]]
operation = "PATCH /review-annotations/{annotation_id}"
field = "completion_status"
reason = "Advertised by the CLI but absent from the served contract, which ignores unknown fields, so the flag silently does nothing. Tracked under COVAL-5824."
[[allowed_extra_field]]
operation = "PATCH /review-annotations/{annotation_id}"
field = "status"
reason = "Advertised by the CLI but absent from the served contract, which ignores unknown fields, so the flag silently does nothing. Tracked under COVAL-5824."
[[allowed_extra_field]]
operation = "POST /conversations/simulated/{simulation_id}/resimulate"
field = "dev_id"
reason = "Served but deliberately hidden from the published schema as an internal field; the API still accepts it."
[[allowed_extra_field]]
operation = "POST /conversations/uploaded:submit"
field = "audio"
reason = "Served but deliberately hidden from the published schema as an internal field; the API still accepts it."
[[known_field_gap]]
operation = "POST /workspaces"
field = "slug"
reason = "Deprecated and ignored by the API, including when null; workspaces are identified by the returned id."
reviewed_at = "2026-11-06"
[[known_gap]]
operation = "GET /conversations/simulated/{conversation_id}/comments"
reason = "Transcript comments need a dedicated cursor-paginated CLI resource with comments:read and workspace selection; they are distinct from metric review annotations."
reviewed_at = "2026-11-02"
[[known_gap]]
operation = "GET /conversations/simulated/{conversation_id}/comments/{comment_id}"
reason = "Transcript comment retrieval belongs to the dedicated comment-thread CLI resource, with conversation ownership and workspace access checks."
reviewed_at = "2026-11-02"
[[known_gap]]
operation = "GET /conversations/uploaded/{conversation_id}/comments"
reason = "Transcript comments need a dedicated cursor-paginated CLI resource with comments:read and workspace selection; they are distinct from metric review annotations."
reviewed_at = "2026-11-02"
[[known_gap]]
operation = "GET /conversations/uploaded/{conversation_id}/comments/{comment_id}"
reason = "Transcript comment retrieval belongs to the dedicated comment-thread CLI resource, with conversation ownership and workspace access checks."
reviewed_at = "2026-11-02"
[[known_gap]]
operation = "POST /conversation-python-analyses"
reason = "Exploratory audio analysis needs a request-UUID recovery and asynchronous-result CLI workflow; the CLI currently supports the immutable metric-draft and preview workflow instead."
reviewed_at = "2026-11-02"
[[known_gap]]
operation = "GET /conversation-python-analyses/{analysis_id}"
reason = "Analysis polling belongs to the dedicated exploratory-audio-analysis CLI workflow, including recovery and expired-result handling."
reviewed_at = "2026-11-02"
[[known_gap]]
operation = "POST /python-metrics:fromAnalysis"
reason = "Publishing from an exploratory analysis needs its own explicit approval workflow; the CLI currently publishes immutable metric drafts using exact fingerprints and successful previews."
reviewed_at = "2026-11-02"
# Published header and query parameters the CLI cannot send yet. An operation of "*" would cover
# every operation that publishes the parameter, which suits a header the client sends everywhere.
[[known_parameter_gap]]
operation = "GET /agents"
in = "query"
name = "tag_filters"
reason = "Tag filtering on list commands remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /metrics"
in = "query"
name = "tag_filters"
reason = "Tag filtering on list commands remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /personas"
in = "query"
name = "tag_filters"
reason = "Tag filtering on list commands remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /run-templates"
in = "query"
name = "tag_filters"
reason = "Tag filtering on list commands remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /test-sets"
in = "query"
name = "tag_filters"
reason = "Tag filtering on list commands remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/simulated"
in = "query"
name = "include"
reason = "Conversation list views, volume windows, time zones and expansions remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/simulated"
in = "query"
name = "time_zone"
reason = "Conversation list views, volume windows, time zones and expansions remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/simulated"
in = "query"
name = "view"
reason = "Conversation list views, volume windows, time zones and expansions remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/simulated"
in = "query"
name = "volume_end_date"
reason = "Conversation list views, volume windows, time zones and expansions remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/simulated"
in = "query"
name = "volume_start_date"
reason = "Conversation list views, volume windows, time zones and expansions remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/uploaded"
in = "query"
name = "aggregation"
reason = "Uploaded-conversation list views, date windows, aggregation and grouping remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/uploaded"
in = "query"
name = "consistency"
reason = "Uploaded-conversation list views, date windows, aggregation and grouping remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/uploaded"
in = "query"
name = "end_date"
reason = "Uploaded-conversation list views, date windows, aggregation and grouping remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/uploaded"
in = "query"
name = "group_by_metadata"
reason = "Uploaded-conversation list views, date windows, aggregation and grouping remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/uploaded"
in = "query"
name = "start_date"
reason = "Uploaded-conversation list views, date windows, aggregation and grouping remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/uploaded"
in = "query"
name = "time_zone"
reason = "Uploaded-conversation list views, date windows, aggregation and grouping remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/uploaded"
in = "query"
name = "view"
reason = "Uploaded-conversation list views, date windows, aggregation and grouping remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/uploaded"
in = "query"
name = "volume_end_date"
reason = "Uploaded-conversation list views, date windows, aggregation and grouping remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/uploaded"
in = "query"
name = "volume_start_date"
reason = "Uploaded-conversation list views, date windows, aggregation and grouping remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/uploaded/{conversation_id}"
in = "query"
name = "include_progress"
reason = "Upload-progress expansion remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/simulated/{conversation_id}/metrics"
in = "query"
name = "filter"
reason = "Per-conversation metric listing does not yet filter, order, page, select a view or include superseded outputs; this remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/simulated/{conversation_id}/metrics"
in = "query"
name = "include_superseded"
reason = "Per-conversation metric listing does not yet filter, order, page, select a view or include superseded outputs; this remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/simulated/{conversation_id}/metrics"
in = "query"
name = "order_by"
reason = "Per-conversation metric listing does not yet filter, order, page, select a view or include superseded outputs; this remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/simulated/{conversation_id}/metrics"
in = "query"
name = "page_size"
reason = "Per-conversation metric listing does not yet filter, order, page, select a view or include superseded outputs; this remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/simulated/{conversation_id}/metrics"
in = "query"
name = "page_token"
reason = "Per-conversation metric listing does not yet filter, order, page, select a view or include superseded outputs; this remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/simulated/{conversation_id}/metrics"
in = "query"
name = "view"
reason = "Per-conversation metric listing does not yet filter, order, page, select a view or include superseded outputs; this remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/uploaded/{conversation_id}/metrics"
in = "query"
name = "filter"
reason = "Per-conversation metric listing does not yet filter, order, page, select a view or include superseded outputs; this remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/uploaded/{conversation_id}/metrics"
in = "query"
name = "include_superseded"
reason = "Per-conversation metric listing does not yet filter, order, page, select a view or include superseded outputs; this remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/uploaded/{conversation_id}/metrics"
in = "query"
name = "order_by"
reason = "Per-conversation metric listing does not yet filter, order, page, select a view or include superseded outputs; this remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/uploaded/{conversation_id}/metrics"
in = "query"
name = "page_size"
reason = "Per-conversation metric listing does not yet filter, order, page, select a view or include superseded outputs; this remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/uploaded/{conversation_id}/metrics"
in = "query"
name = "page_token"
reason = "Per-conversation metric listing does not yet filter, order, page, select a view or include superseded outputs; this remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /conversations/uploaded/{conversation_id}/metrics"
in = "query"
name = "view"
reason = "Per-conversation metric listing does not yet filter, order, page, select a view or include superseded outputs; this remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /metrics/{metric_id}/baselines"
in = "query"
name = "agent_id"
reason = "Baseline filtering by agent, persona, test set and status, and custom sigma levels, remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /metrics/{metric_id}/baselines"
in = "query"
name = "persona_id"
reason = "Baseline filtering by agent, persona, test set and status, and custom sigma levels, remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /metrics/{metric_id}/baselines"
in = "query"
name = "sigma_levels"
reason = "Baseline filtering by agent, persona, test set and status, and custom sigma levels, remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /metrics/{metric_id}/baselines"
in = "query"
name = "status"
reason = "Baseline filtering by agent, persona, test set and status, and custom sigma levels, remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /metrics/{metric_id}/baselines"
in = "query"
name = "test_set_id"
reason = "Baseline filtering by agent, persona, test set and status, and custom sigma levels, remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /metrics/{metric_id}/baselines/{baseline_id}"
in = "query"
name = "sigma_levels"
reason = "Baseline filtering by agent, persona, test set and status, and custom sigma levels, remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /metrics/{metric_id}/thresholds"
in = "query"
name = "page_size"
reason = "Threshold listing does not page yet; this remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /metrics/{metric_id}/thresholds"
in = "query"
name = "page_token"
reason = "Threshold listing does not page yet; this remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "POST /review-annotations"
in = "query"
name = "project_id"
reason = "Project-scoped review annotation access remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /review-annotations/{annotation_id}"
in = "query"
name = "project_id"
reason = "Project-scoped review annotation access remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "PATCH /review-annotations/{annotation_id}"
in = "query"
name = "project_id"
reason = "Project-scoped review annotation access remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "DELETE /review-annotations/{annotation_id}"
in = "query"
name = "project_id"
reason = "Project-scoped review annotation access remains to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /runs"
in = "query"
name = "include"
reason = "Run list expansions remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /tags"
in = "query"
name = "include_usage"
reason = "Tag search, usage counts, unused-tag filtering and paging remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /tags"
in = "query"
name = "page_size"
reason = "Tag search, usage counts, unused-tag filtering and paging remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /tags"
in = "query"
name = "page_token"
reason = "Tag search, usage counts, unused-tag filtering and paging remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /tags"
in = "query"
name = "search"
reason = "Tag search, usage counts, unused-tag filtering and paging remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /tags"
in = "query"
name = "tag_id"
reason = "Tag search, usage counts, unused-tag filtering and paging remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "GET /tags"
in = "query"
name = "unused_only"
reason = "Tag search, usage counts, unused-tag filtering and paging remain to be modeled under COVAL-2079."
reviewed_at = "2026-11-06"
[[known_parameter_gap]]
operation = "PATCH /reports/{report_id}"
in = "header"
name = "If-Match"
reason = "Optimistic concurrency for report updates remains to be modeled under COVAL-2079; the CLI updates reports without a revision precondition."
reviewed_at = "2026-11-06"
# Parameters the CLI sends that the published OpenAPI does not list.
[[allowed_extra_parameter]]
operation = "GET /api-keys"
in = "query"
name = "environment"
reason = "Served by the public API, which filters keys by environment, but omitted from its published OpenAPI parameters."