uptrakit-web-api-types 0.0.1

Shared HTTP request/response types for the Uptrakit web API
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

use serde::{Deserialize, Serialize};

use crate::enrollment_tokens::EnrollmentTokensSummary;
use crate::settings::RegistrationSettingsResponse;
use crate::settings_agent_certs::AgentCertificateSettingsResponse;
use crate::settings_auth::AuthenticationSettingsResponse;
use crate::settings_nats::NatsSettingsResponse;
use crate::settings_network::NetworkSettingsResponse;

#[derive(Serialize, Deserialize)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub struct CombinedSettingsResponse {
    pub registration: RegistrationSettingsResponse,
    pub authentication: AuthenticationSettingsResponse,
    pub agent_certificates: AgentCertificateSettingsResponse,
    pub enrollment_tokens: EnrollmentTokensSummary,
    pub multi_tenancy_enabled: bool,
}

/// Combined response for all global (infrastructure-scoped) settings.
///
/// Returned by `GET /api/v1/global-settings`. This is the single call a
/// global-settings UI page needs to populate all its sections. The `nats`
/// field is omitted from serialized output when it is `None` (i.e. when the
/// controller is compiled without NATS support).
///
/// System service enrollment tokens are managed via the dedicated
/// `/api/v1/system-enrollment-tokens` endpoints.
#[derive(Serialize, Deserialize)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub struct GlobalSettingsCombinedResponse {
    pub network: NetworkSettingsResponse,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub nats: Option<NatsSettingsResponse>,
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::registration::RegistrationMode;

    #[test]
    fn combined_settings_response_round_trip() {
        let resp = CombinedSettingsResponse {
            registration: RegistrationSettingsResponse {
                mode: RegistrationMode::Invite,
                require_token_for_oidc: false,
            },
            authentication: AuthenticationSettingsResponse {
                password_auth_enabled: true,
            },
            agent_certificates: AgentCertificateSettingsResponse {
                lifetime_hours: 8_760,
                renewal_window_hours_override: None,
                effective_renewal_window_hours: 336,
            },
            enrollment_tokens: EnrollmentTokensSummary { active_count: 2 },
            multi_tenancy_enabled: false,
        };
        let json = serde_json::to_string(&resp).expect("serialization should succeed");
        let de: CombinedSettingsResponse =
            serde_json::from_str(&json).expect("deserialization should succeed");
        assert_eq!(de.registration.mode, RegistrationMode::Invite);
        assert!(de.authentication.password_auth_enabled);
        assert_eq!(de.agent_certificates.lifetime_hours, 8_760);
        assert_eq!(de.enrollment_tokens.active_count, 2);
        assert!(!de.multi_tenancy_enabled);
    }
}