feagi_api/
openapi.rs

1// Copyright 2025 Neuraville Inc.
2// SPDX-License-Identifier: Apache-2.0
3
4// OpenAPI documentation generation
5//
6// This module generates the OpenAPI 3.0 specification at compile-time
7// using utoipa, ensuring the documentation stays in sync with the code.
8
9use utoipa::openapi::security::{ApiKey, ApiKeyValue, SecurityScheme};
10use utoipa::OpenApi;
11
12use crate::{
13    common::ApiError,
14    v1::{
15        BrainRegionDetail,
16        BrainRegionListResponse,
17        // Brain region DTOs
18        BrainRegionSummary,
19        BurstCountResponse,
20
21        ComponentReadiness,
22
23        ConnectivityStatsResponse,
24        ConnectomeAnalyticsResponse,
25        Coordinates3D,
26        CorticalAreaDetail,
27        CorticalAreaListResponse,
28        CorticalAreaStatsResponse,
29        // Cortical area DTOs
30        CorticalAreaSummary,
31        CreateBrainRegionRequest,
32
33        CreateCorticalAreaRequest,
34        CreateNeuronRequest,
35        Dimensions3D,
36
37        // Genome DTOs
38        GenomeInfoResponse,
39        // Health DTOs
40        HealthCheckResponseV1,
41        LoadGenomeRequest,
42        NeuronCountResponse,
43
44        NeuronDensityResponse,
45        // Neuron DTOs
46        NeuronInfoResponse,
47        NeuronListResponse,
48        PopulatedAreaInfo,
49        PopulatedAreasResponse,
50        ReadinessCheckResponseV1,
51        // Runtime DTOs
52        RuntimeStatusResponse,
53        SaveGenomeRequest,
54        SaveGenomeResponse,
55        SetFrequencyRequest,
56        // Analytics DTOs
57        SystemHealthResponse,
58        UpdateCorticalAreaRequest,
59        ValidateGenomeRequest,
60        ValidateGenomeResponse,
61    },
62};
63
64/// OpenAPI documentation for FEAGI REST API
65#[derive(OpenApi)]
66#[openapi(
67    info(
68        title = "FEAGI REST API",
69        version = "1.0.0",
70        description = "Comprehensive REST API for FEAGI (Foundational Engine for Artificial General Intelligence)",
71        license(
72            name = "Apache-2.0",
73            url = "https://www.apache.org/licenses/LICENSE-2.0"
74        ),
75        contact(
76            name = "FEAGI Team",
77            url = "https://feagi.org",
78            email = "contact@feagi.org"
79        )
80    ),
81    servers(
82        (url = "http://localhost:8000", description = "Default FEAGI server"),
83        (url = "http://localhost:8080", description = "Alternative port")
84    ),
85    paths(
86        // Agent endpoints (registration uses ZMQ/WebSocket only)
87        crate::endpoints::agent::heartbeat,
88        crate::endpoints::agent::list_agents,
89        crate::endpoints::agent::get_agent_properties,
90        crate::endpoints::agent::get_agent_properties_path,
91        crate::endpoints::agent::get_shared_memory,
92        crate::endpoints::agent::deregister_agent,
93        crate::endpoints::agent::manual_stimulation,
94        crate::endpoints::agent::get_fq_sampler_status,
95        crate::endpoints::agent::get_capabilities,
96        crate::endpoints::agent::get_all_agent_capabilities,
97        crate::endpoints::agent::get_agent_info,
98        crate::endpoints::agent::post_configure,
99
100        // System endpoints (21 total)
101        crate::endpoints::system::get_health_check,
102        crate::endpoints::system::get_cortical_area_visualization_skip_rate,
103        crate::endpoints::system::set_cortical_area_visualization_skip_rate,
104        crate::endpoints::system::get_cortical_area_visualization_suppression_threshold,
105        crate::endpoints::system::set_cortical_area_visualization_suppression_threshold,
106        crate::endpoints::system::get_version,
107        crate::endpoints::system::get_versions,
108        crate::endpoints::system::get_configuration,
109        crate::endpoints::system::get_user_preferences,
110        crate::endpoints::system::put_user_preferences,
111        crate::endpoints::system::get_cortical_area_types_list,
112        crate::endpoints::system::post_enable_visualization_fq_sampler,
113        crate::endpoints::system::post_disable_visualization_fq_sampler,
114        crate::endpoints::system::get_fcl_status_system,
115        crate::endpoints::system::post_fcl_reset_system,
116        crate::endpoints::system::get_processes,
117        crate::endpoints::system::get_unique_logs,
118        crate::endpoints::system::post_logs,
119        crate::endpoints::system::get_beacon_subscribers,
120        crate::endpoints::system::post_beacon_subscribe,
121        crate::endpoints::system::delete_beacon_unsubscribe,
122        crate::endpoints::system::get_global_activity_visualization,
123        crate::endpoints::system::put_global_activity_visualization,
124        crate::endpoints::system::post_circuit_library_path,
125        crate::endpoints::system::get_influxdb_test,
126        crate::endpoints::system::post_register_system,
127
128        // Cortical Area endpoints
129        crate::endpoints::cortical_area::get_ipu,
130        crate::endpoints::cortical_area::get_ipu_types,
131        crate::endpoints::cortical_area::get_opu,
132        crate::endpoints::cortical_area::get_opu_types,
133        crate::endpoints::cortical_area::get_cortical_area_id_list,
134        crate::endpoints::cortical_area::get_cortical_area_name_list,
135        crate::endpoints::cortical_area::get_cortical_id_name_mapping,
136        crate::endpoints::cortical_area::get_cortical_types,
137        crate::endpoints::cortical_area::get_cortical_map_detailed,
138        crate::endpoints::cortical_area::get_cortical_locations_2d,
139        crate::endpoints::cortical_area::get_cortical_area_geometry,
140        crate::endpoints::cortical_area::get_cortical_visibility,
141        crate::endpoints::cortical_area::post_cortical_name_location,
142        crate::endpoints::cortical_area::post_cortical_area_properties,
143        crate::endpoints::cortical_area::post_multi_cortical_area_properties,
144        crate::endpoints::cortical_area::post_cortical_area,
145        crate::endpoints::cortical_area::put_cortical_area,
146        crate::endpoints::cortical_area::delete_cortical_area,
147        crate::endpoints::cortical_area::post_custom_cortical_area,
148        crate::endpoints::cortical_area::post_clone,
149        crate::endpoints::cortical_area::put_multi_cortical_area,
150        crate::endpoints::cortical_area::delete_multi_cortical_area,
151        crate::endpoints::cortical_area::put_coord_2d,
152        crate::endpoints::cortical_area::put_suppress_cortical_visibility,
153        crate::endpoints::cortical_area::put_reset,
154        crate::endpoints::cortical_area::get_visualization,
155        crate::endpoints::cortical_area::post_batch_operations,
156        crate::endpoints::cortical_area::get_ipu_list,
157        crate::endpoints::cortical_area::get_opu_list,
158        crate::endpoints::cortical_area::put_coordinates_3d,
159        crate::endpoints::cortical_area::delete_bulk,
160        crate::endpoints::cortical_area::post_clone,
161        crate::endpoints::cortical_area::post_resize,
162        crate::endpoints::cortical_area::post_reposition,
163        crate::endpoints::cortical_area::get_voxel_neurons,
164        crate::endpoints::cortical_area::post_voxel_neurons,
165        crate::endpoints::cortical_area::get_memory_cortical_area,
166        crate::endpoints::cortical_area::get_cortical_area_index_list,
167        crate::endpoints::cortical_area::get_cortical_idx_mapping,
168        crate::endpoints::cortical_area::get_mapping_restrictions_query,
169        crate::endpoints::cortical_area::get_memory_usage,
170        crate::endpoints::cortical_area::get_area_neuron_count,
171        crate::endpoints::cortical_area::post_cortical_type_options,
172        crate::endpoints::cortical_area::post_mapping_restrictions,
173        crate::endpoints::cortical_area::post_mapping_restrictions_between_areas,
174        crate::endpoints::cortical_area::put_coord_3d,
175
176        // Morphology endpoints
177        crate::endpoints::morphology::get_morphology_list,
178        crate::endpoints::morphology::get_morphology_types,
179        crate::endpoints::morphology::get_list_types,
180        crate::endpoints::morphology::get_morphologies,
181        crate::endpoints::morphology::post_morphology,
182        crate::endpoints::morphology::put_morphology,
183        crate::endpoints::morphology::put_rename_morphology,
184        crate::endpoints::morphology::delete_morphology_by_name,
185        crate::endpoints::morphology::delete_morphology,  // This is delete_by_id
186        crate::endpoints::morphology::post_morphology_properties,
187        crate::endpoints::morphology::post_morphology_usage,
188        crate::endpoints::morphology::get_list,
189        crate::endpoints::morphology::get_info,
190        crate::endpoints::morphology::post_create,
191        crate::endpoints::morphology::put_update,
192
193        // Genome endpoints (22 total)
194        crate::endpoints::genome::get_file_name,
195        crate::endpoints::genome::get_circuits,
196        crate::endpoints::genome::post_amalgamation_destination,
197        crate::endpoints::genome::delete_amalgamation_cancellation,
198        crate::endpoints::genome::post_genome_append,
199        crate::endpoints::genome::post_upload_barebones_genome,
200        crate::endpoints::genome::post_upload_essential_genome,
201        crate::endpoints::genome::get_name,
202        crate::endpoints::genome::get_timestamp,
203        crate::endpoints::genome::post_save,
204        crate::endpoints::genome::post_load,
205        crate::endpoints::genome::post_upload,
206        crate::endpoints::genome::get_download,
207        crate::endpoints::genome::get_properties,
208        crate::endpoints::genome::post_validate,
209        crate::endpoints::genome::post_transform,
210        crate::endpoints::genome::post_clone,
211        crate::endpoints::genome::post_reset,
212        crate::endpoints::genome::get_metadata,
213        crate::endpoints::genome::post_merge,
214        crate::endpoints::genome::get_diff,
215        crate::endpoints::genome::post_export_format,
216        crate::endpoints::genome::get_amalgamation,
217        crate::endpoints::genome::get_amalgamation_history_exact,
218        crate::endpoints::genome::get_cortical_template,
219        crate::endpoints::genome::get_defaults_files,
220        crate::endpoints::genome::get_download_region,
221        crate::endpoints::genome::get_genome_number,
222        crate::endpoints::genome::post_amalgamation_by_filename,
223        crate::endpoints::genome::post_amalgamation_by_payload,
224        crate::endpoints::genome::post_amalgamation_by_upload,
225        crate::endpoints::genome::post_append_file,
226        crate::endpoints::genome::post_upload_file,
227        crate::endpoints::genome::post_upload_file_edit,
228        crate::endpoints::genome::post_upload_string,
229
230        // Cortical Mapping endpoints (8 total)
231        crate::endpoints::cortical_mapping::post_afferents,
232        crate::endpoints::cortical_mapping::post_efferents,
233        crate::endpoints::cortical_mapping::post_mapping_properties,
234        crate::endpoints::cortical_mapping::put_mapping_properties,
235        crate::endpoints::cortical_mapping::get_mapping,
236        crate::endpoints::cortical_mapping::get_mapping_list,
237        crate::endpoints::cortical_mapping::delete_mapping,
238        crate::endpoints::cortical_mapping::post_batch_update,
239        crate::endpoints::cortical_mapping::post_mapping,
240        crate::endpoints::cortical_mapping::put_mapping,
241
242        // Region endpoints (12 total)
243        crate::endpoints::region::get_regions_members,
244        crate::endpoints::region::post_region,
245        crate::endpoints::region::put_region,
246        crate::endpoints::region::delete_region,
247        crate::endpoints::region::post_clone,
248        crate::endpoints::region::put_relocate_members,
249        crate::endpoints::region::delete_region_and_members,
250        crate::endpoints::region::get_regions,
251        crate::endpoints::region::get_region_titles,
252        crate::endpoints::region::get_region_detail,
253        crate::endpoints::region::put_change_region_parent,
254        crate::endpoints::region::put_change_cortical_area_region,
255
256        // Connectome endpoints (21 total)
257        crate::endpoints::connectome::get_cortical_areas_list_detailed,
258        crate::endpoints::connectome::get_properties_dimensions,
259        crate::endpoints::connectome::get_properties_mappings,
260        crate::endpoints::connectome::get_snapshot,
261        crate::endpoints::connectome::get_stats,
262        crate::endpoints::connectome::post_batch_neuron_operations,
263        crate::endpoints::connectome::post_batch_synapse_operations,
264        crate::endpoints::connectome::get_neuron_count,
265        crate::endpoints::connectome::get_synapse_count,
266        crate::endpoints::connectome::get_paths,
267        crate::endpoints::connectome::get_cumulative_stats,
268        crate::endpoints::connectome::get_area_details,
269        crate::endpoints::connectome::post_rebuild,
270        crate::endpoints::connectome::get_structure,
271        crate::endpoints::connectome::post_clear,
272        crate::endpoints::connectome::get_validation,
273        crate::endpoints::connectome::get_topology,
274        crate::endpoints::connectome::post_optimize,
275        crate::endpoints::connectome::get_connectivity_matrix,
276        crate::endpoints::connectome::post_neurons_batch,
277        crate::endpoints::connectome::post_synapses_batch,
278        crate::endpoints::connectome::get_cortical_areas_list_summary,
279        crate::endpoints::connectome::get_cortical_areas_list_transforming,
280        crate::endpoints::connectome::get_cortical_area_list_types,
281        crate::endpoints::connectome::get_cortical_area_neurons,
282        crate::endpoints::connectome::get_area_synapses,
283        crate::endpoints::connectome::get_cortical_info,
284        crate::endpoints::connectome::get_stats_cortical_cumulative,
285        crate::endpoints::connectome::get_neuron_properties_by_id,
286        crate::endpoints::connectome::get_neuron_properties_query,
287        crate::endpoints::connectome::get_neuron_properties_at_query,
288        crate::endpoints::connectome::get_memory_neuron,
289        crate::endpoints::connectome::get_area_neurons_query,
290        crate::endpoints::connectome::get_fire_queue_area,
291        crate::endpoints::connectome::get_plasticity_info,
292        crate::endpoints::connectome::get_path_query,
293        crate::endpoints::connectome::get_download_connectome,
294        crate::endpoints::connectome::get_download_cortical_area,
295        crate::endpoints::connectome::post_upload_connectome,
296        crate::endpoints::connectome::post_upload_cortical_area,
297
298        // Burst Engine endpoints (14 total)
299        crate::endpoints::burst_engine::get_simulation_timestep,
300        crate::endpoints::burst_engine::post_simulation_timestep,
301        crate::endpoints::burst_engine::get_fcl,
302        crate::endpoints::burst_engine::get_fcl_neuron,
303        crate::endpoints::burst_engine::get_fire_queue,
304        crate::endpoints::burst_engine::get_fire_queue_neuron,
305        crate::endpoints::burst_engine::post_fcl_reset,
306        crate::endpoints::burst_engine::get_fcl_status,
307        crate::endpoints::burst_engine::get_fcl_sampler_config,
308        crate::endpoints::burst_engine::post_fcl_sampler_config,
309        crate::endpoints::burst_engine::get_area_fcl_sample_rate,
310        crate::endpoints::burst_engine::post_area_fcl_sample_rate,
311        crate::endpoints::burst_engine::get_fire_ledger_default_window_size,
312        crate::endpoints::burst_engine::put_fire_ledger_default_window_size,
313        crate::endpoints::burst_engine::get_fire_ledger_areas_window_config,
314        crate::endpoints::burst_engine::get_stats,
315        crate::endpoints::burst_engine::get_status,
316        crate::endpoints::burst_engine::post_control,
317        crate::endpoints::burst_engine::get_burst_counter,
318        crate::endpoints::burst_engine::post_start,
319        crate::endpoints::burst_engine::post_stop,
320        crate::endpoints::burst_engine::post_hold,
321        crate::endpoints::burst_engine::post_resume,
322        crate::endpoints::burst_engine::get_config,
323        crate::endpoints::burst_engine::put_config,
324        crate::endpoints::burst_engine::get_fire_ledger_area_window_size,
325        crate::endpoints::burst_engine::put_fire_ledger_area_window_size,
326        crate::endpoints::burst_engine::get_fire_ledger_history,
327        crate::endpoints::burst_engine::get_membrane_potentials,
328        crate::endpoints::burst_engine::put_membrane_potentials,
329        crate::endpoints::burst_engine::get_frequency_status,
330        crate::endpoints::burst_engine::post_measure_frequency,
331        crate::endpoints::burst_engine::get_frequency_history,
332        crate::endpoints::burst_engine::post_force_connectome_integration,
333
334        // Insight endpoints
335        crate::endpoints::insight::post_neurons_membrane_potential_status,
336        crate::endpoints::insight::post_neuron_synaptic_potential_status,
337        crate::endpoints::insight::post_neurons_membrane_potential_set,
338        crate::endpoints::insight::post_neuron_synaptic_potential_set,
339
340        // Neuroplasticity endpoints (7 total)
341        crate::endpoints::neuroplasticity::get_plasticity_queue_depth,
342        crate::endpoints::neuroplasticity::put_plasticity_queue_depth,
343        crate::endpoints::neuroplasticity::get_status,
344        crate::endpoints::neuroplasticity::get_transforming,
345        crate::endpoints::neuroplasticity::post_configure,
346        crate::endpoints::neuroplasticity::post_enable_area,
347        crate::endpoints::neuroplasticity::post_disable_area,
348
349        // Input endpoints
350        crate::endpoints::input::get_vision,
351        crate::endpoints::input::post_vision,
352
353        // Outputs endpoints
354        crate::endpoints::outputs::get_targets,
355        crate::endpoints::outputs::post_configure,
356
357        // Physiology endpoints
358        crate::endpoints::physiology::get_physiology,
359        crate::endpoints::physiology::put_physiology,
360
361        // Simulation endpoints
362        crate::endpoints::simulation::post_stimulation_upload,
363        crate::endpoints::simulation::post_reset,
364        crate::endpoints::simulation::get_status,
365        crate::endpoints::simulation::get_stats,
366        crate::endpoints::simulation::post_config,
367
368        // Training endpoints
369        crate::endpoints::training::post_shock,
370        crate::endpoints::training::get_shock_options,
371        crate::endpoints::training::get_shock_status,
372        crate::endpoints::training::post_reward_intensity,
373        crate::endpoints::training::post_punishment_intensity,
374        crate::endpoints::training::post_gameover,
375        crate::endpoints::training::get_brain_fitness,
376        crate::endpoints::training::get_fitness_criteria,
377        crate::endpoints::training::put_fitness_criteria,
378        crate::endpoints::training::get_fitness_stats,
379        crate::endpoints::training::get_training_report,
380        crate::endpoints::training::get_status,
381        crate::endpoints::training::get_stats,
382        crate::endpoints::training::post_config,
383
384        // Visualization endpoints
385        crate::endpoints::visualization::post_register_client,
386        crate::endpoints::visualization::post_unregister_client,
387        crate::endpoints::visualization::post_heartbeat,
388        crate::endpoints::visualization::get_status,
389
390        // Monitoring endpoints
391        crate::endpoints::monitoring::get_status,
392        crate::endpoints::monitoring::get_metrics,
393        crate::endpoints::monitoring::get_data,
394
395        // Evolution endpoints
396        crate::endpoints::evolution::get_status,
397        crate::endpoints::evolution::post_config,
398
399        // Snapshot endpoints
400        // TODO: Implement snapshot endpoints
401        // crate::endpoints::snapshot::post_create,
402        // crate::endpoints::snapshot::post_restore,
403        // crate::endpoints::snapshot::get_list,
404        // crate::endpoints::snapshot::delete_snapshot,
405        // crate::endpoints::snapshot::get_artifact,
406        // crate::endpoints::snapshot::post_compare,
407        // crate::endpoints::snapshot::post_upload,
408
409        // Network endpoints
410        crate::endpoints::network::get_status,
411        crate::endpoints::network::post_config,
412        crate::endpoints::network::get_connection_info,
413    ),
414    components(
415        schemas(
416            // Common
417            ApiError,
418
419            // Health
420            HealthCheckResponseV1,
421            ReadinessCheckResponseV1,
422            ComponentReadiness,
423
424            // Agent
425            crate::v1::AgentRegistrationRequest,
426
427            // Outputs
428            crate::v1::OutputTargetsResponse,
429            crate::v1::OutputConfigRequest,
430            crate::v1::OutputConfigResponse,
431
432            // Physiology
433            crate::v1::PhysiologyResponse,
434            crate::v1::PhysiologyParameters,
435            crate::v1::PhysiologyUpdateRequest,
436            crate::v1::PhysiologyUpdateResponse,
437
438            // Burst Engine
439            crate::v1::FCLResponse,
440            crate::v1::FireQueueResponse,
441            crate::v1::FCLStatusResponse,
442            crate::v1::FireLedgerConfigResponse,
443            crate::v1::BurstEngineStats,
444            crate::v1::BurstEngineStatus,
445            crate::v1::BurstEngineControlRequest,
446
447            // Monitoring
448            crate::v1::MonitoringStatusResponse,
449            crate::v1::SystemMetricsResponse,
450            crate::v1::MonitoringData,
451            crate::v1::MonitoringDataResponse,
452
453            // Simulation
454            crate::v1::StimulationUploadRequest,
455            crate::v1::SimulationControlRequest,
456            crate::v1::SimulationStatusResponse,
457            crate::v1::SimulationStatsResponse,
458            crate::v1::SimulationSuccessResponse,
459
460            // Training
461            crate::v1::ShockConfigRequest,
462            crate::v1::ShockOptionsResponse,
463            crate::v1::ShockStatusResponse,
464            crate::v1::IntensityRequest,
465            crate::v1::BrainFitnessResponse,
466            crate::v1::FitnessCriteriaResponse,
467            crate::v1::FitnessCriteriaUpdateRequest,
468            crate::v1::FitnessStatsResponse,
469            crate::v1::TrainingReportResponse,
470            crate::v1::TrainingStatusResponse,
471            crate::v1::TrainingStatsResponse,
472            crate::v1::TrainingConfigRequest,
473            crate::v1::TrainingSuccessResponse,
474
475            // Visualization
476            crate::v1::VisualizationClientRequest,
477            crate::v1::VisualizationClientResponse,
478            crate::v1::VisualizationHeartbeatRequest,
479            crate::v1::VisualizationStatusResponse,
480            crate::v1::VisualizationSuccessResponse,
481
482            // Evolution
483            crate::v1::EvolutionStatusResponse,
484            crate::v1::EvolutionConfigRequest,
485            crate::v1::EvolutionSuccessResponse,
486
487            // Snapshot
488            crate::v1::SnapshotCreateRequest,
489            crate::v1::SnapshotCreateResponse,
490            crate::v1::SnapshotRestoreRequest,
491            crate::v1::SnapshotListResponse,
492            crate::v1::SnapshotInfo,
493            crate::v1::SnapshotArtifactResponse,
494            crate::v1::SnapshotCompareRequest,
495            crate::v1::SnapshotCompareResponse,
496            crate::v1::SnapshotUploadRequest,
497            crate::v1::SnapshotUploadResponse,
498            crate::v1::SnapshotSuccessResponse,
499
500            // Network
501            crate::v1::NetworkStatusResponse,
502            crate::v1::NetworkConnectionInfo,
503            crate::v1::ConnectionInfoApi,
504            crate::v1::ConnectionInfoZmq,
505            crate::v1::ConnectionInfoZmqPorts,
506            crate::v1::ConnectionInfoZmqEndpoints,
507            crate::v1::ConnectionInfoWebSocket,
508            crate::v1::ConnectionInfoWebSocketPorts,
509            crate::v1::ConnectionInfoWebSocketEndpoints,
510            crate::v1::ConnectionInfoShm,
511            crate::v1::ConnectionInfoUdp,
512            crate::v1::ConnectionInfoBluetooth,
513            crate::v1::ConnectionInfoStreamStatus,
514            crate::v1::NetworkConfigRequest,
515            crate::v1::NetworkSuccessResponse,
516            crate::v1::AgentRegistrationResponse,
517            crate::v1::HeartbeatRequest,
518            crate::v1::HeartbeatResponse,
519            crate::v1::AgentListResponse,
520            crate::v1::AgentPropertiesResponse,
521            crate::v1::AgentCapabilitiesSummary,
522            crate::v1::AgentDeregistrationRequest,
523            crate::v1::SuccessResponse,
524            crate::v1::ManualStimulationRequest,
525            crate::v1::ManualStimulationResponse,
526            crate::v1::DeviceRegistrationExportResponse,
527            crate::v1::DeviceRegistrationImportRequest,
528            crate::v1::DeviceRegistrationImportResponse,
529
530            // System
531            crate::endpoints::system::HealthCheckResponse,
532
533            // Cortical Area
534            crate::endpoints::cortical_area::CorticalAreaIdListResponse,
535            crate::endpoints::cortical_area::CorticalAreaNameListResponse,
536            crate::endpoints::cortical_area::CorticalAreaResetRequest,
537            crate::endpoints::cortical_area::CorticalAreaResetResponse,
538            crate::endpoints::cortical_area::CorticalAreaResetItem,
539            crate::endpoints::cortical_area::CorticalTypeMetadata,
540            crate::endpoints::cortical_area::VoxelNeuronsQuery,
541            crate::endpoints::cortical_area::VoxelNeuronsBody,
542            crate::endpoints::cortical_area::VoxelNeuronsResponse,
543            crate::endpoints::cortical_area::MemoryCorticalAreaQuery,
544            crate::endpoints::cortical_area::MemoryCorticalAreaParamsResponse,
545            crate::endpoints::cortical_area::MemoryCorticalAreaResponse,
546            crate::endpoints::connectome::MemoryNeuronQuery,
547            crate::endpoints::connectome::MemoryNeuronDetailResponse,
548
549            // Morphology
550            crate::endpoints::morphology::MorphologyListResponse,
551            crate::endpoints::morphology::RenameMorphologyRequest,
552
553            // Cortical Areas
554            CorticalAreaSummary,
555            CorticalAreaDetail,
556            CorticalAreaListResponse,
557            CreateCorticalAreaRequest,
558            UpdateCorticalAreaRequest,
559            Coordinates3D,
560            Dimensions3D,
561
562            // Brain Regions
563            BrainRegionSummary,
564            BrainRegionDetail,
565            BrainRegionListResponse,
566            CreateBrainRegionRequest,
567
568            // Genome
569            GenomeInfoResponse,
570            LoadGenomeRequest,
571            SaveGenomeRequest,
572            SaveGenomeResponse,
573            ValidateGenomeRequest,
574            ValidateGenomeResponse,
575            crate::endpoints::genome::GenomeFileUploadForm,
576
577            // Neurons
578            NeuronInfoResponse,
579            CreateNeuronRequest,
580            NeuronListResponse,
581            NeuronCountResponse,
582
583            // Runtime
584            RuntimeStatusResponse,
585            SetFrequencyRequest,
586            BurstCountResponse,
587
588            // Analytics
589            SystemHealthResponse,
590            CorticalAreaStatsResponse,
591            ConnectivityStatsResponse,
592            ConnectomeAnalyticsResponse,
593            PopulatedAreasResponse,
594            PopulatedAreaInfo,
595            NeuronDensityResponse,
596        )
597    ),
598    tags(
599        (name = "agent", description = "Agent registration and heartbeat"),
600        (name = "system", description = "System health and configuration"),
601        (name = "cortical_area", description = "Cortical area management"),
602        (name = "morphology", description = "Morphology management"),
603        (name = "genome", description = "Genome operations"),
604        (name = "cortical_mapping", description = "Cortical mapping operations"),
605        (name = "region", description = "Brain region management"),
606        (name = "connectome", description = "Connectome operations"),
607        (name = "burst_engine", description = "Burst engine configuration and FCL/Fire Queue"),
608        (name = "insight", description = "Neuron insight operations"),
609        (name = "neuroplasticity", description = "Neuroplasticity configuration"),
610        (name = "input", description = "Input operations"),
611        (name = "outputs", description = "Output/motor target management"),
612        (name = "physiology", description = "Physiology parameter configuration"),
613        (name = "simulation", description = "Simulation control and stimulation"),
614        (name = "training", description = "Reinforcement learning and training"),
615        (name = "visualization", description = "Visualization client management"),
616        (name = "monitoring", description = "System monitoring and metrics"),
617        (name = "evolution", description = "Evolutionary algorithms"),
618        (name = "snapshot", description = "Brain snapshot management"),
619        (name = "network", description = "Network configuration"),
620    ),
621    modifiers(&SecurityAddon)
622)]
623pub struct ApiDoc;
624
625/// Security scheme configuration
626struct SecurityAddon;
627
628impl utoipa::Modify for SecurityAddon {
629    fn modify(&self, openapi: &mut utoipa::openapi::OpenApi) {
630        if let Some(components) = openapi.components.as_mut() {
631            // API Key authentication (for future use)
632            components.add_security_scheme(
633                "api_key",
634                SecurityScheme::ApiKey(ApiKey::Header(ApiKeyValue::new("X-API-Key"))),
635            );
636
637            // JWT Bearer authentication (for future use)
638            components.add_security_scheme(
639                "bearer_auth",
640                SecurityScheme::Http(
641                    utoipa::openapi::security::HttpBuilder::new()
642                        .scheme(utoipa::openapi::security::HttpAuthScheme::Bearer)
643                        .bearer_format("JWT")
644                        .build(),
645                ),
646            );
647        }
648    }
649}
650
651/// Get OpenAPI JSON specification
652pub fn get_openapi_json() -> String {
653    ApiDoc::openapi()
654        .to_pretty_json()
655        .unwrap_or_else(|e| format!(r#"{{"error": "Failed to generate OpenAPI spec: {}"}}"#, e))
656}
657
658/// Get OpenAPI YAML specification
659pub fn get_openapi_yaml() -> String {
660    // utoipa supports YAML output, but we need to implement it
661    // For now, return a notice
662    "# OpenAPI YAML generation not yet implemented\n# Use /openapi.json instead".to_string()
663}
664
665#[cfg(test)]
666mod tests {
667    use super::*;
668
669    #[test]
670    fn test_openapi_generation() {
671        let json = get_openapi_json();
672        assert!(json.contains("FEAGI REST API"));
673        assert!(json.contains("health"));
674        assert!(json.contains("ready"));
675    }
676
677    #[test]
678    fn test_openapi_components() {
679        let openapi = ApiDoc::openapi();
680        assert!(openapi.components.is_some());
681
682        let components = openapi.components.unwrap();
683        assert!(components.schemas.contains_key("HealthCheckResponseV1"));
684        assert!(components.schemas.contains_key("ApiError"));
685        assert!(components.schemas.contains_key("VoxelNeuronsBody"));
686        assert!(components.schemas.contains_key("VoxelNeuronsResponse"));
687        assert!(components.schemas.contains_key("VoxelNeuronsQuery"));
688        assert!(components
689            .schemas
690            .contains_key("MemoryCorticalAreaResponse"));
691        assert!(components
692            .schemas
693            .contains_key("MemoryNeuronDetailResponse"));
694    }
695
696    #[test]
697    fn test_openapi_amalgamation_by_upload_is_multipart_form() {
698        let openapi = ApiDoc::openapi();
699        let json = serde_json::to_value(&openapi).expect("serialize openapi");
700
701        let content =
702            &json["paths"]["/v1/genome/amalgamation_by_upload"]["post"]["requestBody"]["content"];
703
704        assert!(
705            content.get("multipart/form-data").is_some(),
706            "Expected multipart/form-data content for /v1/genome/amalgamation_by_upload requestBody. Got: {}",
707            content
708        );
709    }
710
711    #[test]
712    fn test_security_schemes() {
713        let openapi = ApiDoc::openapi();
714        let components = openapi.components.unwrap();
715
716        assert!(components.security_schemes.contains_key("api_key"));
717        assert!(components.security_schemes.contains_key("bearer_auth"));
718    }
719}
feagi_api/openapi.rs

feagi_api/
openapi.rs
