noetl-server 2.4.3

NoETL Control Plane - Async Rust server for workflow orchestration
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
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

//! Keychain API handlers.
//!
//! Endpoints for token/credential caching with scope support.

use axum::{
    extract::{Path, Query, State},
    Json,
};
use serde::Deserialize;

use crate::db::models::{
    KeychainDeleteResponse, KeychainGetResponse, KeychainListResponse, KeychainSetRequest,
    KeychainSetResponse,
};
use crate::error::AppResult;
use crate::services::KeychainService;

/// Query parameters for keychain operations.
#[derive(Debug, Deserialize, Default)]
pub struct KeychainQuery {
    /// Execution ID for local/shared scope
    pub execution_id: Option<i64>,

    /// Scope type: "local", "global", or "shared"
    #[serde(default = "default_scope")]
    pub scope_type: String,
}

fn default_scope() -> String {
    "global".to_string()
}

/// Get a keychain entry.
///
/// `GET /api/keychain/{catalog_id}/{keychain_name}`
///
/// # Path Parameters
///
/// - `catalog_id`: Catalog ID of the playbook
/// - `keychain_name`: Name of the keychain entry
///
/// # Query Parameters
///
/// - `execution_id`: Execution ID for local/shared scope
/// - `scope_type`: Scope type ("local", "global", "shared")
///
/// # Response
///
/// ```json
/// {
///   "status": "found",
///   "data": {"access_token": "..."},
///   "expires_at": "2025-01-01T01:00:00Z",
///   "auto_renew": true,
///   "access_count": 5
/// }
/// ```
pub async fn get(
    State(service): State<KeychainService>,
    Path((catalog_id, keychain_name)): Path<(i64, String)>,
    Query(query): Query<KeychainQuery>,
) -> AppResult<Json<KeychainGetResponse>> {
    let response = service
        .get(
            catalog_id,
            &keychain_name,
            query.execution_id,
            &query.scope_type,
        )
        .await?;
    Ok(Json(response))
}

/// Set a keychain entry.
///
/// `POST /api/keychain/{catalog_id}/{keychain_name}`
///
/// # Path Parameters
///
/// - `catalog_id`: Catalog ID of the playbook
/// - `keychain_name`: Name of the keychain entry
///
/// # Request Body
///
/// ```json
/// {
///   "data": {"access_token": "...", "refresh_token": "..."},
///   "scope_type": "global",
///   "expires_in": 3600,
///   "auto_renew": true,
///   "renew_config": {...}
/// }
/// ```
///
/// # Response
///
/// ```json
/// {
///   "status": "success",
///   "cache_key": "token:123456789:global",
///   "expires_at": "2025-01-01T01:00:00Z"
/// }
/// ```
pub async fn set(
    service: State<KeychainService>,
    path: Path<(i64, String)>,
    request: Json<KeychainSetRequest>,
) -> AppResult<Json<KeychainSetResponse>> {
    let started_at = std::time::Instant::now();
    let result = set_inner(service, path, request).await;
    let status_label = if result.is_ok() { "ok" } else { "error" };
    crate::metrics::record_write_request(
        crate::metrics::endpoint::KEYCHAIN_SET,
        status_label,
        started_at.elapsed().as_secs_f64(),
    );
    result
}

async fn set_inner(
    State(service): State<KeychainService>,
    Path((catalog_id, keychain_name)): Path<(i64, String)>,
    Json(request): Json<KeychainSetRequest>,
) -> AppResult<Json<KeychainSetResponse>> {
    let response = service.set(catalog_id, &keychain_name, request).await?;
    Ok(Json(response))
}

/// Delete a keychain entry.
///
/// `DELETE /api/keychain/{catalog_id}/{keychain_name}`
///
/// # Path Parameters
///
/// - `catalog_id`: Catalog ID of the playbook
/// - `keychain_name`: Name of the keychain entry
///
/// # Query Parameters
///
/// - `execution_id`: Execution ID for local/shared scope
/// - `scope_type`: Scope type ("local", "global", "shared")
///
/// # Response
///
/// ```json
/// {
///   "status": "deleted",
///   "cache_key": "token:123456789:global"
/// }
/// ```
pub async fn delete(
    State(service): State<KeychainService>,
    Path((catalog_id, keychain_name)): Path<(i64, String)>,
    Query(query): Query<KeychainQuery>,
) -> AppResult<Json<KeychainDeleteResponse>> {
    let response = service
        .delete(
            catalog_id,
            &keychain_name,
            query.execution_id,
            &query.scope_type,
        )
        .await?;
    Ok(Json(response))
}

/// List all keychain entries for a catalog.
///
/// `GET /api/keychain/catalog/{catalog_id}`
///
/// # Path Parameters
///
/// - `catalog_id`: Catalog ID of the playbook
///
/// # Response
///
/// ```json
/// {
///   "catalog_id": "123456789",
///   "entries": [
///     {
///       "keychain_name": "api_token",
///       "scope_type": "global",
///       "expires_at": "2025-01-01T01:00:00Z",
///       "expired": false,
///       "access_count": 5
///     }
///   ]
/// }
/// ```
pub async fn list_by_catalog(
    State(service): State<KeychainService>,
    Path(catalog_id): Path<i64>,
) -> AppResult<Json<KeychainListResponse>> {
    let response = service.list_by_catalog(catalog_id).await?;
    Ok(Json(response))
}