swarmhive-api-types 0.1.0

SwarmHive HTTP API types: serde DTO + utoipa schema shared by server, CLI, and any future client.
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

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use utoipa::ToSchema;
use uuid::Uuid;

/// 某个 backend 的对象如何生成下载 URL。
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, ToSchema)]
#[serde(rename_all = "lowercase")]
pub enum UrlMode {
    /// 公开桶:直接给出以 `public_base_url` 为根的明文 URL。
    Public,
    /// 私有桶:给出短时效的预签名 GET URL。
    Signed,
}

/// S3 兼容存储后端配置。secret 永不返回——`secret_set` 表示是否已存有 secret。
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ToSchema)]
pub struct StorageBackendView {
    pub id: Uuid,
    pub name: String,
    pub kind: String,
    pub active: bool,
    pub endpoint: String,
    pub bucket: String,
    pub region: String,
    pub access_key_id: String,
    pub secret_set: bool,
    pub force_path_style: bool,
    pub prefix: Option<String>,
    pub public_base_url: Option<String>,
    pub url_mode: UrlMode,
    pub signed_url_ttl_secs: i64,
    pub supports_sha256_checksum: bool,
    pub connectivity_status: Option<serde_json::Value>,
    pub created_at: DateTime<Utc>,
    pub updated_at: DateTime<Utc>,
}

fn default_ttl_secs() -> i64 {
    600
}

#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct CreateStorageBackendRequest {
    pub name: String,
    pub endpoint: String,
    pub bucket: String,
    pub region: String,
    pub access_key_id: String,
    pub access_key_secret: String,
    #[serde(default)]
    pub force_path_style: bool,
    #[serde(default)]
    pub prefix: Option<String>,
    #[serde(default)]
    pub public_base_url: Option<String>,
    pub url_mode: UrlMode,
    #[serde(default = "default_ttl_secs")]
    pub signed_url_ttl_secs: i64,
}

/// 全可选的 patch。`access_key_secret` 缺省 / 为空则保留已存的 secret 不变。
#[derive(Debug, Clone, Default, Serialize, Deserialize, ToSchema)]
pub struct UpdateStorageBackendRequest {
    #[serde(default)]
    pub name: Option<String>,
    #[serde(default)]
    pub endpoint: Option<String>,
    #[serde(default)]
    pub bucket: Option<String>,
    #[serde(default)]
    pub region: Option<String>,
    #[serde(default)]
    pub access_key_id: Option<String>,
    #[serde(default)]
    pub access_key_secret: Option<String>,
    #[serde(default)]
    pub force_path_style: Option<bool>,
    #[serde(default)]
    pub prefix: Option<String>,
    #[serde(default)]
    pub public_base_url: Option<String>,
    #[serde(default)]
    pub url_mode: Option<UrlMode>,
    #[serde(default)]
    pub signed_url_ttl_secs: Option<i64>,
}

/// `POST /storage/backends/:id/test` 的返回结果。
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct StorageTestResult {
    pub ok: bool,
    pub supports_sha256_checksum: bool,
    pub detail: String,
}

/// `POST /storage/backends/:id/cors` 的请求:把这些源写进桶 CORS,放行浏览器直传。
/// 通常是 Admin SPA 自己的 origin(`window.location.origin`)。
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct CorsConfigRequest {
    pub allowed_origins: Vec<String>,
}

/// `POST /storage/backends/:id/cors` 的返回结果。`ok=false` 表示后端(如阿里云 OSS
/// 的 S3 兼容层)不支持 `PutBucketCors`,`detail` 给出手动配置指引(非 5xx)。
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct CorsConfigResult {
    pub ok: bool,
    pub detail: String,
}