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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221

//! OpenAPI documentation for the Admin API.
//!
//! This module defines the OpenAPI spec for `/admin/api/v1/*` endpoints,
//! including user management, groups, deployments, and other administrative functions.

use utoipa::{
    Modify, OpenApi,
    openapi::security::{ApiKey, ApiKeyValue, HttpAuthScheme, HttpBuilder, SecurityScheme},
};

use crate::{api, sync};

/// Security schemes for the Admin API.
struct AdminSecurityAddon;

impl Modify for AdminSecurityAddon {
    fn modify(&self, openapi: &mut utoipa::openapi::OpenApi) {
        if let Some(components) = openapi.components.as_mut() {
            // Add Bearer token authentication (API keys)
            components.security_schemes.insert(
                "BearerAuth".to_string(),
                SecurityScheme::Http(
                    HttpBuilder::new()
                        .scheme(HttpAuthScheme::Bearer)
                        .bearer_format("API Key")
                        .description(Some("Enter your API key"))
                        .build(),
                ),
            );

            // Add session cookie authentication (JWT)
            components.security_schemes.insert(
                "CookieAuth".to_string(),
                SecurityScheme::ApiKey(ApiKey::Cookie(ApiKeyValue::new("session"))),
            );

            // Add proxy header authentication (legacy)
            components.security_schemes.insert(
                "X-Doubleword-User".to_string(),
                SecurityScheme::ApiKey(ApiKey::Header(ApiKeyValue::new("X-Doubleword-User"))),
            );
        }
    }
}

#[derive(OpenApi)]
#[openapi(
    servers(
        (url = "/admin/api/v1", description = "Admin API server")
    ),
    modifiers(&AdminSecurityAddon),
    paths(
        api::handlers::auth::register,
        api::handlers::auth::login,
        api::handlers::auth::logout,
        api::handlers::auth::request_password_reset,
        api::handlers::auth::confirm_password_reset,
        api::handlers::users::list_users,
        api::handlers::users::create_user,
        api::handlers::users::get_user,
        api::handlers::users::update_user,
        api::handlers::users::delete_user,
        api::handlers::api_keys::list_user_api_keys,
        api::handlers::api_keys::create_user_api_key,
        api::handlers::api_keys::get_user_api_key,
        api::handlers::api_keys::delete_user_api_key,
        api::handlers::inference_endpoints::list_inference_endpoints,
        api::handlers::inference_endpoints::get_inference_endpoint,
        api::handlers::inference_endpoints::create_inference_endpoint,
        api::handlers::inference_endpoints::update_inference_endpoint,
        api::handlers::inference_endpoints::delete_inference_endpoint,
        api::handlers::inference_endpoints::validate_inference_endpoint,
        api::handlers::inference_endpoints::synchronize_endpoint,
        api::handlers::deployments::list_deployed_models,
        api::handlers::deployments::create_deployed_model,
        api::handlers::deployments::get_deployed_model,
        api::handlers::deployments::update_deployed_model,
        api::handlers::deployments::delete_deployed_model,
        api::handlers::deployments::get_model_components,
        api::handlers::deployments::add_model_component,
        api::handlers::deployments::update_model_component,
        api::handlers::deployments::remove_model_component,
        api::handlers::provider_display_configs::list_provider_display_configs,
        api::handlers::provider_display_configs::get_provider_display_config,
        api::handlers::provider_display_configs::create_provider_display_config,
        api::handlers::provider_display_configs::update_provider_display_config,
        api::handlers::provider_display_configs::delete_provider_display_config,
        api::handlers::groups::list_groups,
        api::handlers::groups::create_group,
        api::handlers::groups::get_group,
        api::handlers::groups::update_group,
        api::handlers::groups::delete_group,
        api::handlers::groups::add_user_to_group,
        api::handlers::groups::remove_user_from_group,
        api::handlers::groups::add_group_to_user,
        api::handlers::groups::remove_group_from_user,
        api::handlers::groups::get_group_users,
        api::handlers::groups::get_user_groups,
        api::handlers::groups::add_deployment_to_group,
        api::handlers::groups::remove_deployment_from_group,
        api::handlers::groups::get_group_deployments,
        api::handlers::groups::get_deployment_groups,
        api::handlers::transactions::create_transaction,
        api::handlers::transactions::get_transaction,
        api::handlers::transactions::list_transactions,
        api::handlers::config::get_config,
        api::handlers::probes::create_probe,
        api::handlers::probes::list_probes,
        api::handlers::probes::get_probe,
        api::handlers::probes::delete_probe,
        api::handlers::probes::activate_probe,
        api::handlers::probes::deactivate_probe,
        api::handlers::probes::update_probe,
        api::handlers::probes::execute_probe,
        api::handlers::probes::test_probe,
        api::handlers::probes::get_probe_results,
        api::handlers::probes::get_statistics,
        api::handlers::requests::list_requests,
        api::handlers::requests::aggregate_requests,
        api::handlers::requests::aggregate_by_user,
        api::handlers::queue::get_pending_request_counts,
    ),
    components(
        schemas(
            api::models::auth::RegisterRequest,
            api::models::auth::LoginRequest,
            api::models::auth::AuthResponse,
            api::models::auth::AuthSuccessResponse,
            api::models::users::Role,
            api::models::users::UserCreate,
            api::models::users::UserUpdate,
            api::models::users::UserResponse,
            api::models::users::CurrentUser,
            api::models::users::ListUsersQuery,
            api::models::api_keys::ApiKeyCreate,
            api::models::api_keys::ApiKeyUpdate,
            api::models::api_keys::ListApiKeysQuery,
            api::models::api_keys::ApiKeyResponse,
            api::models::api_keys::ApiKeyInfoResponse,
            api::models::deployments::DeployedModelCreate,
            api::models::deployments::DeployedModelUpdate,
            api::models::deployments::DeployedModelUpdateRequest,
            api::models::deployments::DeployedModelResponse,
            api::models::deployments::ModelComponentCreate,
            api::models::deployments::ModelComponentUpdate,
            api::models::deployments::ModelComponentResponse,
            crate::db::models::deployments::LoadBalancingStrategy,
            crate::db::models::deployments::FallbackConfig,
            crate::db::models::deployments::DeploymentComponent,
            api::models::groups::GroupCreate,
            api::models::groups::GroupUpdate,
            api::models::groups::GroupResponse,
            api::models::groups::ListGroupsQuery,
            api::models::deployments::ListModelsQuery,
            api::models::deployments::ModelSortField,
            api::models::deployments::SortDirection,
            api::models::deployments::ModelFacets,
            api::models::deployments::ModelListResponse,
            api::models::provider_display_configs::CreateProviderDisplayConfig,
            api::models::provider_display_configs::UpdateProviderDisplayConfig,
            api::models::provider_display_configs::ProviderDisplayConfigResponse,
            api::models::inference_endpoints::InferenceEndpointCreate,
            api::models::inference_endpoints::InferenceEndpointUpdate,
            api::models::inference_endpoints::InferenceEndpointValidate,
            api::models::inference_endpoints::InferenceEndpointValidateResponse,
            api::models::inference_endpoints::InferenceEndpointResponse,
            api::models::inference_endpoints::ListEndpointsQuery,
            api::models::inference_endpoints::OpenAIModel,
            api::models::inference_endpoints::OpenAIModelsResponse,
            api::models::transactions::CreditTransactionCreate,
            api::models::transactions::CreditTransactionResponse,
            crate::db::models::credits::CreditTransactionType,
            sync::endpoint_sync::EndpointSyncResponse,
            api::models::probes::CreateProbe,
            api::models::probes::TestProbeRequest,
            api::models::probes::ProbesQuery,
            api::models::probes::ResultsQuery,
            api::models::probes::StatsQuery,
            api::models::probes::UpdateProbeRequest,
            api::models::probes::ProbeStatistics,
            crate::db::models::probes::Probe,
            crate::db::models::probes::ProbeResult,
            api::models::requests::ApiAiRequest,
            api::models::requests::ApiAiResponse,
            api::models::requests::AggregateRequestsQuery,
            api::models::requests::ListRequestsQuery,
            api::models::requests::HttpRequest,
            api::models::requests::HttpResponse,
            api::models::requests::RequestResponsePair,
            api::models::requests::ListRequestsResponse,
            api::models::requests::StatusCodeBreakdown,
            api::models::requests::ModelUsage,
            api::models::requests::UserUsage,
            api::models::requests::ModelUserUsageResponse,
            api::models::requests::TimeSeriesPoint,
            api::models::requests::RequestsAggregateResponse,
            api::handlers::config::ConfigResponse,
            api::handlers::config::BatchConfigResponse,
        )
    ),
    tags(
        (name = "auth", description = "Authentication API"),
        (name = "users", description = "User management API"),
        (name = "api_keys", description = "API key management"),
        (name = "endpoints", description = "Endpoint management"),
        (name = "models", description = "Deployed model management"),
        (name = "composite-models", description = "Composite model management - virtual models with weighted load balancing"),
        (name = "groups", description = "Group management API"),
        (name = "transactions", description = "Credit transaction management API"),
        (name = "config", description = "Configuration API"),
        (name = "probes", description = "Probe monitoring API"),
        (name = "requests", description = "Request logging and analytics API"),
        (name = "monitoring", description = "Queue and system monitoring API"),
    ),
    info(
        title = "Admin API",
        version = "0.1.0",
        description = "API for managing users, API keys, inference endpoints, and deployed models",
    ),
)]
pub struct AdminApiDoc;