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 (14 total)
87        crate::endpoints::agent::register_agent,
88        crate::endpoints::agent::heartbeat,
89        crate::endpoints::agent::list_agents,
90        crate::endpoints::agent::get_agent_properties,
91        crate::endpoints::agent::get_agent_properties_path,
92        crate::endpoints::agent::get_shared_memory,
93        crate::endpoints::agent::deregister_agent,
94        crate::endpoints::agent::manual_stimulation,
95        crate::endpoints::agent::get_fq_sampler_status,
96        crate::endpoints::agent::get_capabilities,
97        crate::endpoints::agent::get_all_agent_capabilities,
98        crate::endpoints::agent::get_agent_info,
99        crate::endpoints::agent::post_configure,
100        crate::endpoints::agent::export_device_registrations,
101        crate::endpoints::agent::import_device_registrations,
102
103        // System endpoints (21 total)
104        crate::endpoints::system::get_health_check,
105        crate::endpoints::system::get_cortical_area_visualization_skip_rate,
106        crate::endpoints::system::set_cortical_area_visualization_skip_rate,
107        crate::endpoints::system::get_cortical_area_visualization_suppression_threshold,
108        crate::endpoints::system::set_cortical_area_visualization_suppression_threshold,
109        crate::endpoints::system::get_version,
110        crate::endpoints::system::get_versions,
111        crate::endpoints::system::get_configuration,
112        crate::endpoints::system::get_user_preferences,
113        crate::endpoints::system::put_user_preferences,
114        crate::endpoints::system::get_cortical_area_types_list,
115        crate::endpoints::system::post_enable_visualization_fq_sampler,
116        crate::endpoints::system::post_disable_visualization_fq_sampler,
117        crate::endpoints::system::get_fcl_status_system,
118        crate::endpoints::system::post_fcl_reset_system,
119        crate::endpoints::system::get_processes,
120        crate::endpoints::system::get_unique_logs,
121        crate::endpoints::system::post_logs,
122        crate::endpoints::system::get_beacon_subscribers,
123        crate::endpoints::system::post_beacon_subscribe,
124        crate::endpoints::system::delete_beacon_unsubscribe,
125        crate::endpoints::system::get_global_activity_visualization,
126        crate::endpoints::system::put_global_activity_visualization,
127        crate::endpoints::system::post_circuit_library_path,
128        crate::endpoints::system::get_influxdb_test,
129        crate::endpoints::system::post_register_system,
130
131        // Cortical Area endpoints
132        crate::endpoints::cortical_area::get_ipu,
133        crate::endpoints::cortical_area::get_ipu_types,
134        crate::endpoints::cortical_area::get_opu,
135        crate::endpoints::cortical_area::get_opu_types,
136        crate::endpoints::cortical_area::get_cortical_area_id_list,
137        crate::endpoints::cortical_area::get_cortical_area_name_list,
138        crate::endpoints::cortical_area::get_cortical_id_name_mapping,
139        crate::endpoints::cortical_area::get_cortical_types,
140        crate::endpoints::cortical_area::get_cortical_map_detailed,
141        crate::endpoints::cortical_area::get_cortical_locations_2d,
142        crate::endpoints::cortical_area::get_cortical_area_geometry,
143        crate::endpoints::cortical_area::get_cortical_visibility,
144        crate::endpoints::cortical_area::post_cortical_name_location,
145        crate::endpoints::cortical_area::post_cortical_area_properties,
146        crate::endpoints::cortical_area::post_multi_cortical_area_properties,
147        crate::endpoints::cortical_area::post_cortical_area,
148        crate::endpoints::cortical_area::put_cortical_area,
149        crate::endpoints::cortical_area::delete_cortical_area,
150        crate::endpoints::cortical_area::post_custom_cortical_area,
151        crate::endpoints::cortical_area::post_clone,
152        crate::endpoints::cortical_area::put_multi_cortical_area,
153        crate::endpoints::cortical_area::delete_multi_cortical_area,
154        crate::endpoints::cortical_area::put_coord_2d,
155        crate::endpoints::cortical_area::put_suppress_cortical_visibility,
156        crate::endpoints::cortical_area::put_reset,
157        crate::endpoints::cortical_area::get_visualization,
158        crate::endpoints::cortical_area::post_batch_operations,
159        crate::endpoints::cortical_area::get_ipu_list,
160        crate::endpoints::cortical_area::get_opu_list,
161        crate::endpoints::cortical_area::put_coordinates_3d,
162        crate::endpoints::cortical_area::delete_bulk,
163        crate::endpoints::cortical_area::post_clone,
164        crate::endpoints::cortical_area::post_resize,
165        crate::endpoints::cortical_area::post_reposition,
166        crate::endpoints::cortical_area::post_voxel_neurons,
167        crate::endpoints::cortical_area::get_cortical_area_index_list,
168        crate::endpoints::cortical_area::get_cortical_idx_mapping,
169        crate::endpoints::cortical_area::get_mapping_restrictions_query,
170        crate::endpoints::cortical_area::get_memory_usage,
171        crate::endpoints::cortical_area::get_area_neuron_count,
172        crate::endpoints::cortical_area::post_cortical_type_options,
173        crate::endpoints::cortical_area::post_mapping_restrictions,
174        crate::endpoints::cortical_area::post_mapping_restrictions_between_areas,
175        crate::endpoints::cortical_area::put_coord_3d,
176
177        // Morphology endpoints
178        crate::endpoints::morphology::get_morphology_list,
179        crate::endpoints::morphology::get_morphology_types,
180        crate::endpoints::morphology::get_list_types,
181        crate::endpoints::morphology::get_morphologies,
182        crate::endpoints::morphology::post_morphology,
183        crate::endpoints::morphology::put_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_area_neurons_query,
289        crate::endpoints::connectome::get_fire_queue_area,
290        crate::endpoints::connectome::get_plasticity_info,
291        crate::endpoints::connectome::get_path_query,
292        crate::endpoints::connectome::get_download_connectome,
293        crate::endpoints::connectome::get_download_cortical_area,
294        crate::endpoints::connectome::post_upload_connectome,
295        crate::endpoints::connectome::post_upload_cortical_area,
296
297        // Burst Engine endpoints (14 total)
298        crate::endpoints::burst_engine::get_simulation_timestep,
299        crate::endpoints::burst_engine::post_simulation_timestep,
300        crate::endpoints::burst_engine::get_fcl,
301        crate::endpoints::burst_engine::get_fcl_neuron,
302        crate::endpoints::burst_engine::get_fire_queue,
303        crate::endpoints::burst_engine::get_fire_queue_neuron,
304        crate::endpoints::burst_engine::post_fcl_reset,
305        crate::endpoints::burst_engine::get_fcl_status,
306        crate::endpoints::burst_engine::get_fcl_sampler_config,
307        crate::endpoints::burst_engine::post_fcl_sampler_config,
308        crate::endpoints::burst_engine::get_area_fcl_sample_rate,
309        crate::endpoints::burst_engine::post_area_fcl_sample_rate,
310        crate::endpoints::burst_engine::get_fire_ledger_default_window_size,
311        crate::endpoints::burst_engine::put_fire_ledger_default_window_size,
312        crate::endpoints::burst_engine::get_fire_ledger_areas_window_config,
313        crate::endpoints::burst_engine::get_stats,
314        crate::endpoints::burst_engine::get_status,
315        crate::endpoints::burst_engine::post_control,
316        crate::endpoints::burst_engine::get_burst_counter,
317        crate::endpoints::burst_engine::post_start,
318        crate::endpoints::burst_engine::post_stop,
319        crate::endpoints::burst_engine::post_hold,
320        crate::endpoints::burst_engine::post_resume,
321        crate::endpoints::burst_engine::get_config,
322        crate::endpoints::burst_engine::put_config,
323        crate::endpoints::burst_engine::get_fire_ledger_area_window_size,
324        crate::endpoints::burst_engine::put_fire_ledger_area_window_size,
325        crate::endpoints::burst_engine::get_fire_ledger_history,
326        crate::endpoints::burst_engine::get_membrane_potentials,
327        crate::endpoints::burst_engine::put_membrane_potentials,
328        crate::endpoints::burst_engine::get_frequency_status,
329        crate::endpoints::burst_engine::post_measure_frequency,
330        crate::endpoints::burst_engine::get_frequency_history,
331        crate::endpoints::burst_engine::post_force_connectome_integration,
332
333        // Insight endpoints
334        crate::endpoints::insight::post_neurons_membrane_potential_status,
335        crate::endpoints::insight::post_neuron_synaptic_potential_status,
336        crate::endpoints::insight::post_neurons_membrane_potential_set,
337        crate::endpoints::insight::post_neuron_synaptic_potential_set,
338
339        // Neuroplasticity endpoints (7 total)
340        crate::endpoints::neuroplasticity::get_plasticity_queue_depth,
341        crate::endpoints::neuroplasticity::put_plasticity_queue_depth,
342        crate::endpoints::neuroplasticity::get_status,
343        crate::endpoints::neuroplasticity::get_transforming,
344        crate::endpoints::neuroplasticity::post_configure,
345        crate::endpoints::neuroplasticity::post_enable_area,
346        crate::endpoints::neuroplasticity::post_disable_area,
347
348        // Input endpoints
349        crate::endpoints::input::get_vision,
350        crate::endpoints::input::post_vision,
351
352        // Outputs endpoints
353        crate::endpoints::outputs::get_targets,
354        crate::endpoints::outputs::post_configure,
355
356        // Physiology endpoints
357        crate::endpoints::physiology::get_physiology,
358        crate::endpoints::physiology::put_physiology,
359
360        // Simulation endpoints
361        crate::endpoints::simulation::post_stimulation_upload,
362        crate::endpoints::simulation::post_reset,
363        crate::endpoints::simulation::get_status,
364        crate::endpoints::simulation::get_stats,
365        crate::endpoints::simulation::post_config,
366
367        // Training endpoints
368        crate::endpoints::training::post_shock,
369        crate::endpoints::training::get_shock_options,
370        crate::endpoints::training::get_shock_status,
371        crate::endpoints::training::post_reward_intensity,
372        crate::endpoints::training::post_punishment_intensity,
373        crate::endpoints::training::post_gameover,
374        crate::endpoints::training::get_brain_fitness,
375        crate::endpoints::training::get_fitness_criteria,
376        crate::endpoints::training::put_fitness_criteria,
377        crate::endpoints::training::get_fitness_stats,
378        crate::endpoints::training::get_training_report,
379        crate::endpoints::training::get_status,
380        crate::endpoints::training::get_stats,
381        crate::endpoints::training::post_config,
382
383        // Visualization endpoints
384        crate::endpoints::visualization::post_register_client,
385        crate::endpoints::visualization::post_unregister_client,
386        crate::endpoints::visualization::post_heartbeat,
387        crate::endpoints::visualization::get_status,
388
389        // Monitoring endpoints
390        crate::endpoints::monitoring::get_status,
391        crate::endpoints::monitoring::get_metrics,
392        crate::endpoints::monitoring::get_data,
393
394        // Evolution endpoints
395        crate::endpoints::evolution::get_status,
396        crate::endpoints::evolution::post_config,
397
398        // Snapshot endpoints
399        // TODO: Implement snapshot endpoints
400        // crate::endpoints::snapshot::post_create,
401        // crate::endpoints::snapshot::post_restore,
402        // crate::endpoints::snapshot::get_list,
403        // crate::endpoints::snapshot::delete_snapshot,
404        // crate::endpoints::snapshot::get_artifact,
405        // crate::endpoints::snapshot::post_compare,
406        // crate::endpoints::snapshot::post_upload,
407
408        // Network endpoints
409        crate::endpoints::network::get_status,
410        crate::endpoints::network::post_config,
411    ),
412    components(
413        schemas(
414            // Common
415            ApiError,
416
417            // Health
418            HealthCheckResponseV1,
419            ReadinessCheckResponseV1,
420            ComponentReadiness,
421
422            // Agent
423            crate::v1::AgentRegistrationRequest,
424
425            // Outputs
426            crate::v1::OutputTargetsResponse,
427            crate::v1::OutputConfigRequest,
428            crate::v1::OutputConfigResponse,
429
430            // Physiology
431            crate::v1::PhysiologyResponse,
432            crate::v1::PhysiologyParameters,
433            crate::v1::PhysiologyUpdateRequest,
434            crate::v1::PhysiologyUpdateResponse,
435
436            // Burst Engine
437            crate::v1::FCLResponse,
438            crate::v1::FireQueueResponse,
439            crate::v1::FCLStatusResponse,
440            crate::v1::FireLedgerConfigResponse,
441            crate::v1::BurstEngineStats,
442            crate::v1::BurstEngineStatus,
443            crate::v1::BurstEngineControlRequest,
444
445            // Monitoring
446            crate::v1::MonitoringStatusResponse,
447            crate::v1::SystemMetricsResponse,
448            crate::v1::MonitoringData,
449            crate::v1::MonitoringDataResponse,
450
451            // Simulation
452            crate::v1::StimulationUploadRequest,
453            crate::v1::SimulationControlRequest,
454            crate::v1::SimulationStatusResponse,
455            crate::v1::SimulationStatsResponse,
456            crate::v1::SimulationSuccessResponse,
457
458            // Training
459            crate::v1::ShockConfigRequest,
460            crate::v1::ShockOptionsResponse,
461            crate::v1::ShockStatusResponse,
462            crate::v1::IntensityRequest,
463            crate::v1::BrainFitnessResponse,
464            crate::v1::FitnessCriteriaResponse,
465            crate::v1::FitnessCriteriaUpdateRequest,
466            crate::v1::FitnessStatsResponse,
467            crate::v1::TrainingReportResponse,
468            crate::v1::TrainingStatusResponse,
469            crate::v1::TrainingStatsResponse,
470            crate::v1::TrainingConfigRequest,
471            crate::v1::TrainingSuccessResponse,
472
473            // Visualization
474            crate::v1::VisualizationClientRequest,
475            crate::v1::VisualizationClientResponse,
476            crate::v1::VisualizationHeartbeatRequest,
477            crate::v1::VisualizationStatusResponse,
478            crate::v1::VisualizationSuccessResponse,
479
480            // Evolution
481            crate::v1::EvolutionStatusResponse,
482            crate::v1::EvolutionConfigRequest,
483            crate::v1::EvolutionSuccessResponse,
484
485            // Snapshot
486            crate::v1::SnapshotCreateRequest,
487            crate::v1::SnapshotCreateResponse,
488            crate::v1::SnapshotRestoreRequest,
489            crate::v1::SnapshotListResponse,
490            crate::v1::SnapshotInfo,
491            crate::v1::SnapshotArtifactResponse,
492            crate::v1::SnapshotCompareRequest,
493            crate::v1::SnapshotCompareResponse,
494            crate::v1::SnapshotUploadRequest,
495            crate::v1::SnapshotUploadResponse,
496            crate::v1::SnapshotSuccessResponse,
497
498            // Network
499            crate::v1::NetworkStatusResponse,
500            crate::v1::NetworkConfigRequest,
501            crate::v1::NetworkSuccessResponse,
502            crate::v1::AgentRegistrationResponse,
503            crate::v1::HeartbeatRequest,
504            crate::v1::HeartbeatResponse,
505            crate::v1::AgentListResponse,
506            crate::v1::AgentPropertiesResponse,
507            crate::v1::AgentCapabilitiesSummary,
508            crate::v1::AgentDeregistrationRequest,
509            crate::v1::SuccessResponse,
510            crate::v1::ManualStimulationRequest,
511            crate::v1::ManualStimulationResponse,
512            crate::v1::DeviceRegistrationExportResponse,
513            crate::v1::DeviceRegistrationImportRequest,
514            crate::v1::DeviceRegistrationImportResponse,
515
516            // System
517            crate::endpoints::system::HealthCheckResponse,
518
519            // Cortical Area
520            crate::endpoints::cortical_area::CorticalAreaIdListResponse,
521            crate::endpoints::cortical_area::CorticalAreaNameListResponse,
522            crate::endpoints::cortical_area::CorticalTypeMetadata,
523
524            // Morphology
525            crate::endpoints::morphology::MorphologyListResponse,
526
527            // Cortical Areas
528            CorticalAreaSummary,
529            CorticalAreaDetail,
530            CorticalAreaListResponse,
531            CreateCorticalAreaRequest,
532            UpdateCorticalAreaRequest,
533            Coordinates3D,
534            Dimensions3D,
535
536            // Brain Regions
537            BrainRegionSummary,
538            BrainRegionDetail,
539            BrainRegionListResponse,
540            CreateBrainRegionRequest,
541
542            // Genome
543            GenomeInfoResponse,
544            LoadGenomeRequest,
545            SaveGenomeRequest,
546            SaveGenomeResponse,
547            ValidateGenomeRequest,
548            ValidateGenomeResponse,
549            crate::endpoints::genome::GenomeFileUploadForm,
550
551            // Neurons
552            NeuronInfoResponse,
553            CreateNeuronRequest,
554            NeuronListResponse,
555            NeuronCountResponse,
556
557            // Runtime
558            RuntimeStatusResponse,
559            SetFrequencyRequest,
560            BurstCountResponse,
561
562            // Analytics
563            SystemHealthResponse,
564            CorticalAreaStatsResponse,
565            ConnectivityStatsResponse,
566            ConnectomeAnalyticsResponse,
567            PopulatedAreasResponse,
568            PopulatedAreaInfo,
569            NeuronDensityResponse,
570        )
571    ),
572    tags(
573        (name = "agent", description = "Agent registration and heartbeat"),
574        (name = "system", description = "System health and configuration"),
575        (name = "cortical_area", description = "Cortical area management"),
576        (name = "morphology", description = "Morphology management"),
577        (name = "genome", description = "Genome operations"),
578        (name = "cortical_mapping", description = "Cortical mapping operations"),
579        (name = "region", description = "Brain region management"),
580        (name = "connectome", description = "Connectome operations"),
581        (name = "burst_engine", description = "Burst engine configuration and FCL/Fire Queue"),
582        (name = "insight", description = "Neuron insight operations"),
583        (name = "neuroplasticity", description = "Neuroplasticity configuration"),
584        (name = "input", description = "Input operations"),
585        (name = "outputs", description = "Output/motor target management"),
586        (name = "physiology", description = "Physiology parameter configuration"),
587        (name = "simulation", description = "Simulation control and stimulation"),
588        (name = "training", description = "Reinforcement learning and training"),
589        (name = "visualization", description = "Visualization client management"),
590        (name = "monitoring", description = "System monitoring and metrics"),
591        (name = "evolution", description = "Evolutionary algorithms"),
592        (name = "snapshot", description = "Brain snapshot management"),
593        (name = "network", description = "Network configuration"),
594    ),
595    modifiers(&SecurityAddon)
596)]
597pub struct ApiDoc;
598
599/// Security scheme configuration
600struct SecurityAddon;
601
602impl utoipa::Modify for SecurityAddon {
603    fn modify(&self, openapi: &mut utoipa::openapi::OpenApi) {
604        if let Some(components) = openapi.components.as_mut() {
605            // API Key authentication (for future use)
606            components.add_security_scheme(
607                "api_key",
608                SecurityScheme::ApiKey(ApiKey::Header(ApiKeyValue::new("X-API-Key"))),
609            );
610
611            // JWT Bearer authentication (for future use)
612            components.add_security_scheme(
613                "bearer_auth",
614                SecurityScheme::Http(
615                    utoipa::openapi::security::HttpBuilder::new()
616                        .scheme(utoipa::openapi::security::HttpAuthScheme::Bearer)
617                        .bearer_format("JWT")
618                        .build(),
619                ),
620            );
621        }
622    }
623}
624
625/// Get OpenAPI JSON specification
626pub fn get_openapi_json() -> String {
627    ApiDoc::openapi()
628        .to_pretty_json()
629        .unwrap_or_else(|e| format!(r#"{{"error": "Failed to generate OpenAPI spec: {}"}}"#, e))
630}
631
632/// Get OpenAPI YAML specification
633pub fn get_openapi_yaml() -> String {
634    // utoipa supports YAML output, but we need to implement it
635    // For now, return a notice
636    "# OpenAPI YAML generation not yet implemented\n# Use /openapi.json instead".to_string()
637}
638
639#[cfg(test)]
640mod tests {
641    use super::*;
642
643    #[test]
644    fn test_openapi_generation() {
645        let json = get_openapi_json();
646        assert!(json.contains("FEAGI REST API"));
647        assert!(json.contains("health"));
648        assert!(json.contains("ready"));
649    }
650
651    #[test]
652    fn test_openapi_components() {
653        let openapi = ApiDoc::openapi();
654        assert!(openapi.components.is_some());
655
656        let components = openapi.components.unwrap();
657        assert!(components.schemas.contains_key("HealthCheckResponseV1"));
658        assert!(components.schemas.contains_key("ApiError"));
659    }
660
661    #[test]
662    fn test_openapi_amalgamation_by_upload_is_multipart_form() {
663        let openapi = ApiDoc::openapi();
664        let json = serde_json::to_value(&openapi).expect("serialize openapi");
665
666        let content =
667            &json["paths"]["/v1/genome/amalgamation_by_upload"]["post"]["requestBody"]["content"];
668
669        assert!(
670            content.get("multipart/form-data").is_some(),
671            "Expected multipart/form-data content for /v1/genome/amalgamation_by_upload requestBody. Got: {}",
672            content
673        );
674    }
675
676    #[test]
677    fn test_security_schemes() {
678        let openapi = ApiDoc::openapi();
679        let components = openapi.components.unwrap();
680
681        assert!(components.security_schemes.contains_key("api_key"));
682        assert!(components.security_schemes.contains_key("bearer_auth"));
683    }
684}
feagi_api/openapi.rs

feagi_api/
openapi.rs
