-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
2315 lines (2216 loc) · 58.2 KB
/
openapi.yaml
File metadata and controls
2315 lines (2216 loc) · 58.2 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
openapi: 3.0.3
info:
title: Sovereign Map Federated Learning Control Plane API
version: 1.0.0
description: |
OpenAPI specification for the Flask control plane exposed by
sovereignmap_production_backend_v2.py.
This API serves operator controls, HUD telemetry, training orchestration,
trust/policy views, and participant join lifecycle operations.
servers:
- url: http://localhost:8000
description: Local development
tags:
- name: Runtime
- name: HUD
- name: Training
- name: Operations
- name: Trust
- name: Join
- name: Marketplace
- name: Governance
- name: Network
paths:
/status:
get:
tags: [Runtime]
summary: Get service runtime status
operationId: getStatus
responses:
'200':
description: Aggregator runtime identity
content:
application/json:
schema:
$ref: '#/components/schemas/StatusResponse'
/health:
get:
tags: [Runtime]
summary: Get service health and telemetry snapshot
operationId: getHealth
responses:
'200':
description: Healthy service snapshot
content:
application/json:
schema:
$ref: '#/components/schemas/HealthResponse'
/chat:
post:
tags: [HUD]
summary: Ask HUD assistant query
operationId: postChat
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
query:
type: string
example: Show current health status
responses:
'200':
description: Assistant response
content:
application/json:
schema:
type: object
properties:
response:
type: string
status:
type: string
example: ok
/hud_data:
get:
tags: [HUD]
summary: Get HUD summary metrics
operationId: getHudData
responses:
'200':
description: HUD data payload
content:
application/json:
schema:
$ref: '#/components/schemas/HudDataResponse'
/founders:
get:
tags: [HUD]
summary: List founders and governance stakes
operationId: getFounders
responses:
'200':
description: Founder list
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Founder'
/convergence:
get:
tags: [Training]
summary: Get full convergence history
operationId: getConvergence
responses:
'200':
description: Convergence time series
content:
application/json:
schema:
$ref: '#/components/schemas/ConvergenceResponse'
'500':
description: Strategy not initialized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/metrics_summary:
get:
tags: [Training]
summary: Get aggregate training and system metrics
operationId: getMetricsSummary
responses:
'200':
description: Metrics summary payload
content:
application/json:
schema:
$ref: '#/components/schemas/MetricsSummaryResponse'
'500':
description: Strategy not initialized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/trigger_fl:
post:
tags: [Training]
summary: Trigger a single manual FL round
operationId: postTriggerFl
responses:
'202':
description: FL round accepted and executed
content:
application/json:
schema:
$ref: '#/components/schemas/TriggerFlResponse'
'503':
description: Strategy unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/TriggerFlResponse'
/training/start:
post:
tags: [Training]
summary: Start background training loop
operationId: postTrainingStart
responses:
'200':
description: Training loop started or already active
content:
application/json:
schema:
$ref: '#/components/schemas/TrainingCommandResponse'
/training/stop:
post:
tags: [Training]
summary: Stop background training loop
operationId: postTrainingStop
responses:
'200':
description: Training loop halted
content:
application/json:
schema:
$ref: '#/components/schemas/TrainingStopResponse'
/training/status:
get:
tags: [Training]
summary: Get training loop status and live metrics
operationId: getTrainingStatus
responses:
'200':
description: Training status payload
content:
application/json:
schema:
$ref: '#/components/schemas/TrainingStatusResponse'
/runtime/profile:
get:
tags: [Runtime]
summary: Get active runtime performance profile and provider policy
operationId: getRuntimeProfile
responses:
'200':
description: Runtime profile snapshot
content:
application/json:
schema:
type: object
properties:
active_profile:
type: object
available_profiles:
type: array
items:
type: string
provider_policy:
type: object
memory_pressure:
type: object
post:
tags: [Runtime]
summary: Update active runtime performance profile
operationId: postRuntimeProfile
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [profile]
properties:
profile:
type: string
enum: [ultra_latency, balanced, throughput]
responses:
'200':
description: Runtime profile updated
content:
application/json:
schema:
type: object
properties:
status:
type: string
active_profile:
type: object
'400':
description: Invalid request body
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorStatusResponse'
/simulate/{simulation_type}:
post:
tags: [Training]
summary: Trigger a simulation event
operationId: postSimulation
parameters:
- name: simulation_type
in: path
required: true
schema:
type: string
enum:
- byzantineAttacks
- networkPartitions
- hardwareFaults
- llmPolicyValid
- llmPolicyRejected
responses:
'200':
description: Simulation recorded
content:
application/json:
schema:
$ref: '#/components/schemas/SimulationResponse'
'400':
description: Unsupported simulation type
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorStatusResponse'
/create_enclave:
post:
tags: [Runtime]
summary: Advance enclave provisioning state machine
operationId: postCreateEnclave
responses:
'200':
description: Enclave state changed
content:
application/json:
schema:
$ref: '#/components/schemas/EnclaveResponse'
'202':
description: Provisioning in progress
content:
application/json:
schema:
$ref: '#/components/schemas/EnclaveInProgressResponse'
/ops/health:
get:
tags: [Operations]
summary: Get operational health snapshot
operationId: getOpsHealth
responses:
'200':
description: Ops health payload
content:
application/json:
schema:
$ref: '#/components/schemas/OpsHealthResponse'
/ops/trends:
get:
tags: [Operations]
summary: Get rolling operational trend series
operationId: getOpsTrends
parameters:
- name: limit
in: query
required: false
schema:
type: integer
minimum: 1
default: 120
responses:
'200':
description: Rolling trend payload for HUD sparklines
content:
application/json:
schema:
$ref: '#/components/schemas/OpsTrendsResponse'
/ops/events/recent:
get:
tags: [Operations]
summary: Get recent operational events
operationId: getOpsEventsRecent
parameters:
- name: limit
in: query
required: false
schema:
type: integer
minimum: 1
default: 100
responses:
'200':
description: Event list response
content:
application/json:
schema:
type: object
properties:
count:
type: integer
events:
type: array
items:
$ref: '#/components/schemas/OpsEvent'
/ops/events:
get:
tags: [Operations]
summary: Stream operational events using SSE
operationId: streamOpsEvents
responses:
'200':
description: Server-sent events stream
content:
text/event-stream:
schema:
type: string
example: "data: {\"id\":1,\"kind\":\"heartbeat\"}\n\n"
/swarm/status:
get:
tags: [Operations]
summary: Get autonomous swarm command-plane status
operationId: getSwarmStatus
responses:
'200':
description: Swarm status snapshot
content:
application/json:
schema:
type: object
additionalProperties: true
/swarm/map:
get:
tags: [Operations]
summary: Get bounded swarm map state for C2 HUD rendering
operationId: getSwarmMap
parameters:
- name: limit
in: query
required: false
schema:
type: integer
minimum: 1
default: 280
- name: layers
in: query
required: false
schema:
type: string
example: paths,risk,coverage,communications
responses:
'200':
description: Swarm map payload
content:
application/json:
schema:
type: object
additionalProperties: true
/swarm/commands:
get:
tags: [Operations]
summary: List recent swarm command records
operationId: getSwarmCommands
parameters:
- name: limit
in: query
required: false
schema:
type: integer
minimum: 1
default: 100
responses:
'200':
description: Swarm command log
content:
application/json:
schema:
type: object
additionalProperties: true
/swarm/audit/recent:
get:
tags: [Operations]
summary: List recent signed swarm audit records (admin)
operationId: getSwarmAuditRecent
security:
- JoinAdminHeader: []
- BearerAuth: []
parameters:
- name: limit
in: query
required: false
schema:
type: integer
minimum: 1
default: 100
responses:
'200':
description: Swarm audit log
content:
application/json:
schema:
type: object
additionalProperties: true
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/swarm/command:
post:
tags: [Operations]
summary: Submit a signed swarm command (admin)
operationId: postSwarmCommand
security:
- JoinAdminHeader: []
- BearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: true
responses:
'200':
description: Command accepted
content:
application/json:
schema:
type: object
additionalProperties: true
'400':
description: Invalid command request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: Rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/autonomy/twin/summary:
get:
tags: [Operations]
summary: Get digital twin summary for autonomy HUD
operationId: getAutonomyTwinSummary
responses:
'200':
description: Twin summary payload
content:
application/json:
schema:
type: object
additionalProperties: true
/autonomy/planner/insights:
get:
tags: [Operations]
summary: Get planner candidate and selection insights
operationId: getAutonomyPlannerInsights
responses:
'200':
description: Planner insight payload
content:
application/json:
schema:
type: object
additionalProperties: true
/autonomy/sensors/quality:
get:
tags: [Operations]
summary: Get autonomy sensor quality matrix
operationId: getAutonomySensorsQuality
responses:
'200':
description: Sensor quality payload
content:
application/json:
schema:
type: object
additionalProperties: true
/autonomy/slo/status:
get:
tags: [Operations]
summary: Get autonomy SLO status
operationId: getAutonomySloStatus
responses:
'200':
description: SLO status payload
content:
application/json:
schema:
type: object
additionalProperties: true
/ai/interaction/summary:
get:
tags: [Operations]
summary: Get structured AI interaction summary for HUD and C2
operationId: getAiInteractionSummary
responses:
'200':
description: AI interaction summary payload
content:
application/json:
schema:
type: object
additionalProperties: true
/ai/interaction/history:
get:
tags: [Operations]
summary: Get recent AI interaction review history
operationId: getAiInteractionHistory
parameters:
- in: query
name: limit
schema:
type: integer
default: 50
description: Maximum number of review records to return
responses:
'200':
description: Recent AI interaction decisions
content:
application/json:
schema:
type: object
additionalProperties: true
/ai/interaction/decision:
post:
tags: [Operations]
summary: Record an AI interaction review decision
operationId: recordAiInteractionDecision
description: |
Records operator review decisions for AI interaction actions.
Authentication defaults to admin-required and can be relaxed for local-only testing with `AI_INTERACTION_DECISION_AUTH_MODE=public_local`.
parameters:
- in: header
name: X-Join-Admin-Token
required: false
schema:
type: string
description: Admin token required when interaction decision auth mode is `admin_required`.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
review_id:
type: string
decision:
type: string
enum: [approve, edit, reject, undo]
action_id:
type: string
action_label:
type: string
action_kind:
type: string
model_route:
type: string
reason:
type: string
prompt:
type: string
command:
type: string
parameters:
type: object
additionalProperties: true
required: [decision]
additionalProperties: true
responses:
'200':
description: Review decision recorded
content:
application/json:
schema:
type: object
additionalProperties: true
'401':
description: Missing or invalid authorization for interaction decision policy
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: unauthorized
auth_mode:
type: string
example: admin_required
hint:
type: string
/model_registry:
get:
tags: [Operations]
summary: Get recent model registry entries
operationId: getModelRegistry
parameters:
- name: limit
in: query
required: false
schema:
type: integer
minimum: 1
default: 100
responses:
'200':
description: Model registry response
content:
application/json:
schema:
type: object
properties:
entries:
type: array
items:
type: object
additionalProperties: true
count:
type: integer
/trust_snapshot:
get:
tags: [Trust]
summary: Get trust and verification snapshot
operationId: getTrustSnapshot
responses:
'200':
description: Trust state payload
content:
application/json:
schema:
$ref: '#/components/schemas/TrustSnapshotResponse'
/verification_policy:
post:
tags: [Trust]
summary: Submit verification policy update request
operationId: postVerificationPolicy
parameters:
- name: X-API-Role
in: header
required: false
schema:
type: string
example: admin
requestBody:
required: false
content:
application/json:
schema:
type: object
additionalProperties: true
responses:
'200':
description: Policy update accepted
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: ok
message:
type: string
example: Policy applied successfully
/mobile/verify_gradient:
post:
tags: [Trust]
summary: Verify signed mobile gradient envelope
operationId: postMobileVerifyGradient
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MobileVerifyGradientRequest'
responses:
'200':
description: Mobile gradient signature accepted
content:
application/json:
schema:
$ref: '#/components/schemas/MobileVerifyGradientSuccess'
'400':
description: Mobile gradient signature rejected
content:
application/json:
schema:
$ref: '#/components/schemas/MobileVerifyGradientError'
/llm_policy:
get:
tags: [Trust]
summary: Get active LLM adapter policy
operationId: getLlmPolicy
responses:
'200':
description: LLM adapter policy
content:
application/json:
schema:
type: object
properties:
enforce:
type: boolean
model_family:
type: string
model_version:
type: string
tokenizer_hash:
type: string
allowed_adapter_ranks:
type: array
items:
type: integer
required_target_modules:
type: array
items:
type: string
max_reported_update_l2_norm:
type: number
/join/policy:
get:
tags: [Join]
summary: Get participant join policy and aggregator address
operationId: getJoinPolicy
responses:
'200':
description: Join policy payload
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LlmPolicy'
- type: object
properties:
aggregator_host:
type: string
aggregator_port:
type: integer
/join/invite:
post:
tags: [Join]
summary: Create join invite (admin)
operationId: postJoinInvite
security:
- JoinAdminHeader: []
- BearerAuth: []
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
participant_name:
type: string
default: participant
max_uses:
type: integer
default: 1
expires_in_hours:
type: integer
default: 24
responses:
'200':
description: Invite created
content:
application/json:
schema:
$ref: '#/components/schemas/JoinInviteResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/join/register:
post:
tags: [Join]
summary: Register participant with invite code
operationId: postJoinRegister
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [invite_code]
properties:
invite_code:
type: string
participant_name:
type: string
default: participant
node_name:
type: string
responses:
'200':
description: Registration completed with certificate bundle
content:
application/json:
schema:
$ref: '#/components/schemas/JoinRegistrationResponse'
'400':
description: Registration rejected
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/join/registrations:
get:
tags: [Join]
summary: List join registrations (admin)
operationId: getJoinRegistrations
security:
- JoinAdminHeader: []
- BearerAuth: []
responses:
'200':
description: Registration list
content:
application/json:
schema:
type: object
properties:
count:
type: integer
registrations:
type: array
items:
$ref: '#/components/schemas/JoinRegistration'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/join/revoke/{node_id}:
post:
tags: [Join]
summary: Revoke participant node certificate (admin)
operationId: postJoinRevoke
security:
- JoinAdminHeader: []
- BearerAuth: []
parameters:
- name: node_id
in: path
required: true
schema:
type: integer
responses:
'200':
description: Revocation successful
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: ok
node_id:
type: integer
revoked:
type: boolean
example: true
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Node certificate not found
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: error
message:
type: string
example: node certificate not found
/marketplace/offers:
post:
tags: [Marketplace]
summary: Create marketplace offer
operationId: postMarketplaceOffer
requestBody:
required: true
content:
application/json:
schema: