feagi-api 0.0.12

FEAGI REST API layer with HTTP and ZMQ transport adapters
Documentation 
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

// Copyright 2025 Neuraville Inc.
// Licensed under the Apache License, Version 2.0

//! Network API DTOs
//!
//! Request/response types for network configuration

use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use utoipa::ToSchema;

/// Network status response
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct NetworkStatusResponse {
    pub zmq_enabled: bool,
    pub http_enabled: bool,
    pub websocket_enabled: bool,
}

/// Network configuration request
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct NetworkConfigRequest {
    pub config: HashMap<String, serde_json::Value>,
}

/// Success response
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct NetworkSuccessResponse {
    pub message: String,
    pub success: bool,
}

// ============================================================================
// Connection Info (GET /v1/network/connection_info)
// ============================================================================

/// API transport section
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct ConnectionInfoApi {
    pub enabled: bool,
    pub base_url: String,
    pub host: String,
    pub port: u16,
    pub swagger_url: String,
}

/// ZMQ transport section
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct ConnectionInfoZmq {
    pub enabled: bool,
    pub host: String,
    pub ports: ConnectionInfoZmqPorts,
    pub endpoints: ConnectionInfoZmqEndpoints,
}

#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct ConnectionInfoZmqPorts {
    pub registration: u16,
    pub sensory: u16,
    pub motor: u16,
    pub visualization: u16,
    pub api_control: u16,
}

#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct ConnectionInfoZmqEndpoints {
    pub registration: String,
    pub sensory: String,
    pub motor: String,
    pub visualization: String,
}

/// WebSocket transport section
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct ConnectionInfoWebSocket {
    pub enabled: bool,
    pub host: String,
    pub ports: ConnectionInfoWebSocketPorts,
    pub endpoints: ConnectionInfoWebSocketEndpoints,
}

#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct ConnectionInfoWebSocketPorts {
    pub registration: u16,
    pub sensory: u16,
    pub motor: u16,
    pub visualization: u16,
    pub rest_api: u16,
}

#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct ConnectionInfoWebSocketEndpoints {
    pub registration: String,
    pub sensory: String,
    pub motor: String,
    pub visualization: String,
}

/// SHM transport section
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct ConnectionInfoShm {
    pub enabled: bool,
    pub base_path: String,
    pub policy: String,
    pub note: String,
}

/// UDP transport section (placeholder)
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct ConnectionInfoUdp {
    pub enabled: bool,
    pub visualization: Option<serde_json::Value>,
    pub sensory: Option<serde_json::Value>,
    pub note: String,
}

/// Bluetooth transport section (placeholder)
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct ConnectionInfoBluetooth {
    pub enabled: bool,
    pub relay_port: Option<u16>,
    pub note: String,
}

/// Stream runtime status
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct ConnectionInfoStreamStatus {
    pub zmq_control_started: bool,
    pub zmq_data_streams_started: bool,
    pub websocket_started: bool,
    pub note: String,
}

/// Full network connection info response
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct NetworkConnectionInfo {
    pub api: ConnectionInfoApi,
    pub zmq: ConnectionInfoZmq,
    pub websocket: ConnectionInfoWebSocket,
    pub shm: ConnectionInfoShm,
    pub udp: ConnectionInfoUdp,
    pub bluetooth: ConnectionInfoBluetooth,
    pub stream_status: ConnectionInfoStreamStatus,
}