dwctl 8.38.2

The Doubleword Control Layer - A self-hostable observability and analytics platform for LLM applications
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

//! API request/response models for API keys.

use super::pagination::Pagination;
use crate::db::models::api_keys::{ApiKeyDBResponse, ApiKeyPurpose};
use crate::types::{ApiKeyId, DeploymentId, UserId};
use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use utoipa::{IntoParams, ToSchema};

/// Default API key purpose when not specified
fn default_api_key_purpose() -> ApiKeyPurpose {
    ApiKeyPurpose::Realtime
}

// API Key request models.
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct ApiKeyCreate {
    pub name: String,
    pub description: Option<String>,
    /// Purpose of the API key. Defaults to 'realtime' if not specified.
    /// 'platform' keys require PlatformManager role. 'batch' and 'playground' are reserved for internal system use.
    #[serde(default = "default_api_key_purpose")]
    pub purpose: ApiKeyPurpose,
    /// Per-API-key rate limit: requests per second (null = no limit)
    pub requests_per_second: Option<f32>,
    /// Per-API-key rate limit: maximum burst size (null = no limit)
    pub burst_size: Option<i32>,
    /// Organization member to attribute this key to. Only usable when the caller has
    /// permission to create keys for any member of the organization (e.g. PlatformManagers
    /// or admins). The specified user must be a member of the org.
    #[schema(value_type = Option<String>, format = "uuid")]
    pub member_id: Option<UserId>,
}

// API Key update.
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct ApiKeyUpdate {
    pub name: Option<String>,
    pub description: Option<String>,
    /// Per-API-key rate limit: requests per second (null = no limit, Some(None) = remove limit)
    pub requests_per_second: Option<Option<f32>>,
    /// Per-API-key rate limit: maximum burst size (null = no limit, Some(None) = remove limit)
    pub burst_size: Option<Option<i32>>,
}

// API Key response models
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct ApiKeyResponse {
    #[schema(value_type = String, format = "uuid")]
    pub id: ApiKeyId,
    pub name: String,
    pub description: Option<String>,
    pub key: String,
    pub purpose: ApiKeyPurpose,
    #[schema(value_type = String, format = "uuid")]
    pub user_id: UserId,
    /// The individual user who created this key
    #[schema(value_type = String, format = "uuid")]
    pub created_by: UserId,
    pub created_at: DateTime<Utc>,
    pub last_used: Option<DateTime<Utc>>,
    #[schema(value_type = Vec<String>)]
    pub model_access: Vec<DeploymentId>,
    /// Per-API-key rate limit: requests per second (null = no limit)
    pub requests_per_second: Option<f32>,
    /// Per-API-key rate limit: maximum burst size (null = no limit)
    pub burst_size: Option<i32>,
}

#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct ApiKeyInfoResponse {
    #[schema(value_type = String, format = "uuid")]
    pub id: ApiKeyId,
    pub name: String,
    pub description: Option<String>,
    pub purpose: ApiKeyPurpose,
    #[schema(value_type = String, format = "uuid")]
    pub user_id: UserId,
    /// The individual user who created this key
    #[schema(value_type = String, format = "uuid")]
    pub created_by: UserId,
    pub created_at: DateTime<Utc>,
    pub last_used: Option<DateTime<Utc>>,
    #[schema(value_type = Vec<String>)]
    pub model_access: Vec<DeploymentId>,
    /// Per-API-key rate limit: requests per second (null = no limit)
    pub requests_per_second: Option<f32>,
    /// Per-API-key rate limit: maximum burst size (null = no limit)
    pub burst_size: Option<i32>,
}

#[derive(Debug, Deserialize, IntoParams, ToSchema)]
pub struct ListApiKeysQuery {
    /// Pagination parameters
    #[serde(flatten)]
    #[param(inline)]
    pub pagination: Pagination,
}

impl From<ApiKeyDBResponse> for ApiKeyResponse {
    fn from(db: ApiKeyDBResponse) -> Self {
        Self {
            id: db.id,
            name: db.name,
            description: db.description,
            key: db.secret,
            purpose: db.purpose,
            user_id: db.user_id,
            created_by: db.created_by,
            created_at: db.created_at,
            last_used: db.last_used,
            model_access: db.model_access,
            requests_per_second: db.requests_per_second,
            burst_size: db.burst_size,
        }
    }
}

impl From<ApiKeyDBResponse> for ApiKeyInfoResponse {
    fn from(db: ApiKeyDBResponse) -> Self {
        Self {
            id: db.id,
            name: db.name,
            description: db.description,
            purpose: db.purpose,
            user_id: db.user_id,
            created_by: db.created_by,
            created_at: db.created_at,
            last_used: db.last_used,
            model_access: db.model_access,
            requests_per_second: db.requests_per_second,
            burst_size: db.burst_size,
        }
    }
}