feagi-api 0.0.6

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

// Copyright 2025 Neuraville Inc.
// SPDX-License-Identifier: Apache-2.0

// API response types

use chrono::Utc;
use serde::{Deserialize, Serialize};
#[cfg(feature = "http")]
use utoipa::ToSchema;

/// Standard API response wrapper
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
#[serde(rename_all = "camelCase")]
pub struct ApiResponse<T> {
    /// Whether the operation succeeded
    pub success: bool,

    /// Response data (present if success = true)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub data: Option<T>,

    /// ISO 8601 timestamp
    pub timestamp: String,
}

impl<T> ApiResponse<T> {
    /// Create a successful response
    pub fn success(data: T) -> Self {
        Self {
            success: true,
            data: Some(data),
            timestamp: Utc::now().to_rfc3339(),
        }
    }

    /// Create an error response (no data)
    pub fn error() -> ApiResponse<()> {
        ApiResponse {
            success: false,
            data: None,
            timestamp: Utc::now().to_rfc3339(),
        }
    }
}

/// Empty response for operations that return no data
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct EmptyResponse {
    /// Operation message
    pub message: String,
}

impl EmptyResponse {
    pub fn new(message: impl Into<String>) -> Self {
        Self {
            message: message.into(),
        }
    }
}