uptrakit-web-api-types 0.0.4

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
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

//! Request/response types for global GitHub provider settings.

use serde::{Deserialize, Serialize};

use crate::validation::{Validate, ValidationError};

/// Response body for `GET /api/v1/global-settings/providers/github`.
#[derive(Clone, Debug, Serialize, Deserialize)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub struct GitHubProviderSettingsResponse {
    /// Custom API base URL override for GitHub Enterprise.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub api_base_url: Option<String>,
    /// Whether an auth token is currently configured.
    pub has_auth_token: bool,
    /// Masked token sentinel (`***`) when a token exists.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub auth_token: Option<String>,
}

/// Request body for `PUT /api/v1/global-settings/providers/github`.
///
/// `auth_token` tri-state semantics:
/// - omit => keep current
/// - `"***"` => keep current
/// - `""` => clear
/// - non-empty => replace
///
/// `api_base_url` semantics:
/// - omit => keep current
/// - `""` => clear
/// - non-empty => validate and replace
#[derive(Clone, Debug, Serialize, Deserialize)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
pub struct UpdateGitHubProviderSettingsRequest {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub auth_token: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub api_base_url: Option<String>,
}

impl Validate for UpdateGitHubProviderSettingsRequest {
    fn validate(&self) -> Result<(), ValidationError> {
        if let Some(api_base_url) = self.api_base_url.as_deref()
            && !api_base_url.is_empty()
            && let Err(err) = uptrakit_shared_types::validate_provider_api_base_url(api_base_url)
        {
            return Err(ValidationError {
                field: "api_base_url",
                message: err.to_string(),
            });
        }
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    #![expect(
        clippy::assertions_on_result_states,
        reason = "test assertions — is_ok/is_err provides readable failure messages"
    )]
    use super::*;

    #[test]
    fn settings_provider_github_validate_accepts_empty_update() {
        let req = UpdateGitHubProviderSettingsRequest {
            auth_token: None,
            api_base_url: None,
        };
        assert!(req.validate().is_ok());
    }

    #[test]
    fn settings_provider_github_validate_accepts_clear_api_base_url() {
        let req = UpdateGitHubProviderSettingsRequest {
            auth_token: None,
            api_base_url: Some(String::new()),
        };
        assert!(req.validate().is_ok());
    }

    #[test]
    fn settings_provider_github_validate_rejects_invalid_api_base_url() {
        let req = UpdateGitHubProviderSettingsRequest {
            auth_token: None,
            api_base_url: Some("http://localhost/api/v3".to_string()),
        };
        let err = req
            .validate()
            .expect_err("must reject private/non-https URL");
        assert_eq!(err.field, "api_base_url");
    }

    #[test]
    fn settings_provider_github_validate_accepts_valid_api_base_url() {
        let req = UpdateGitHubProviderSettingsRequest {
            auth_token: None,
            api_base_url: Some("https://ghe.example.com/api/v3".to_string()),
        };
        assert!(req.validate().is_ok());
    }

    #[test]
    fn settings_provider_github_request_serialization_omits_absent_fields() {
        let req = UpdateGitHubProviderSettingsRequest {
            auth_token: None,
            api_base_url: None,
        };
        let json = serde_json::to_value(&req).expect("serialize");
        assert!(json.get("auth_token").is_none());
        assert!(json.get("api_base_url").is_none());
    }

    #[test]
    fn settings_provider_github_response_serialization() {
        let resp = GitHubProviderSettingsResponse {
            api_base_url: Some("https://ghe.example.com/api/v3".to_string()),
            has_auth_token: true,
            auth_token: Some("***".to_string()),
        };
        let json = serde_json::to_value(&resp).expect("serialize");
        assert_eq!(json["api_base_url"], "https://ghe.example.com/api/v3");
        assert_eq!(json["has_auth_token"], true);
        assert_eq!(json["auth_token"], "***");
    }
}