heliosdb-nano 3.30.0

PostgreSQL-compatible embedded database with TDE + ZKE encryption, HNSW vector search, Product Quantization, git-like branching, time-travel queries, materialized views, row-level security, and 50+ enterprise features
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242

//! OpenAPI specification serving and documentation UI
//!
//! This module provides:
//! - OpenAPI 3.0 spec serving at /v1/openapi.json and /v1/openapi.yaml
//! - Swagger UI at /v1/docs
//! - ReDoc documentation at /v1/redoc

use axum::{
    body::Body,
    http::{header, StatusCode},
    response::{Html, Response},
    routing::get,
    Router,
};
use crate::api::server::AppState;

/// Create a minimal error response that cannot fail
///
/// This is used as a fallback when building more detailed responses fails.
/// Uses only safe operations that are guaranteed to succeed.
fn minimal_error_response() -> Response {
    // SAFETY: This construction cannot fail because:
    // 1. StatusCode::INTERNAL_SERVER_ERROR is a valid status code
    // 2. Body::empty() cannot fail
    // 3. No headers are being set that could be invalid
    Response::builder()
        .status(StatusCode::INTERNAL_SERVER_ERROR)
        .body(Body::empty())
        .unwrap_or_else(|_| {
            // Ultimate fallback using default - this branch is unreachable
            // in practice but satisfies the type system
            Response::default()
        })
}

/// The OpenAPI specification as a static string (embedded at compile time)
pub const OPENAPI_YAML: &str = include_str!("openapi.yaml");

/// OpenAPI routes
pub fn routes() -> Router<AppState> {
    Router::new()
        .route("/openapi.json", get(openapi_json))
        .route("/openapi.yaml", get(openapi_yaml))
        .route("/docs", get(swagger_ui))
        .route("/docs/", get(swagger_ui))
        .route("/redoc", get(redoc_ui))
        .route("/redoc/", get(redoc_ui))
}

/// Serve OpenAPI spec as JSON
async fn openapi_json() -> Response {
    match serde_yaml::from_str::<serde_json::Value>(OPENAPI_YAML) {
        Ok(spec) => {
            let json = serde_json::to_string_pretty(&spec).unwrap_or_default();
            Response::builder()
                .status(StatusCode::OK)
                .header(header::CONTENT_TYPE, "application/json")
                .header(header::ACCESS_CONTROL_ALLOW_ORIGIN, "*")
                .body(Body::from(json))
                .unwrap_or_else(|_| minimal_error_response())
        }
        Err(e) => Response::builder()
            .status(StatusCode::INTERNAL_SERVER_ERROR)
            .body(Body::from(format!("Failed to parse OpenAPI spec: {}", e)))
            .unwrap_or_else(|_| minimal_error_response()),
    }
}

/// Serve OpenAPI spec as YAML
async fn openapi_yaml() -> Response {
    Response::builder()
        .status(StatusCode::OK)
        .header(header::CONTENT_TYPE, "application/x-yaml")
        .header(header::ACCESS_CONTROL_ALLOW_ORIGIN, "*")
        .body(Body::from(OPENAPI_YAML))
        .unwrap_or_else(|_| minimal_error_response())
}

/// Serve Swagger UI
async fn swagger_ui() -> Html<String> {
    let html = format!(
        r#"<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>HeliosDB Nano API Documentation</title>
    <link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@5.9.0/swagger-ui.css">
    <style>
        body {{
            margin: 0;
            padding: 0;
        }}
        .swagger-ui .topbar {{
            background-color: #1a1a2e;
        }}
        .swagger-ui .info .title {{
            color: #1a1a2e;
        }}
        .swagger-ui .btn.execute {{
            background-color: #4f46e5;
            border-color: #4f46e5;
        }}
        .swagger-ui .btn.execute:hover {{
            background-color: #4338ca;
            border-color: #4338ca;
        }}
        .helios-header {{
            background: linear-gradient(135deg, #1a1a2e 0%, #16213e 100%);
            color: white;
            padding: 1rem 2rem;
            display: flex;
            align-items: center;
            gap: 1rem;
        }}
        .helios-header h1 {{
            margin: 0;
            font-size: 1.5rem;
            font-weight: 600;
        }}
        .helios-header .version {{
            background: #4f46e5;
            padding: 0.25rem 0.75rem;
            border-radius: 9999px;
            font-size: 0.875rem;
        }}
    </style>
</head>
<body>
    <div class="helios-header">
        <h1>HeliosDB Nano</h1>
        <span class="version">v3.3.0</span>
    </div>
    <div id="swagger-ui"></div>
    <script src="https://unpkg.com/swagger-ui-dist@5.9.0/swagger-ui-bundle.js"></script>
    <script src="https://unpkg.com/swagger-ui-dist@5.9.0/swagger-ui-standalone-preset.js"></script>
    <script>
        window.onload = function() {{
            SwaggerUIBundle({{
                url: "/v1/openapi.json",
                dom_id: '#swagger-ui',
                deepLinking: true,
                presets: [
                    SwaggerUIBundle.presets.apis,
                    SwaggerUIStandalonePreset
                ],
                plugins: [
                    SwaggerUIBundle.plugins.DownloadUrl
                ],
                layout: "StandaloneLayout",
                validatorUrl: null,
                supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],
                docExpansion: 'list',
                filter: true,
                showRequestHeaders: true,
                showCommonExtensions: true
            }});
        }};
    </script>
</body>
</html>"#
    );
    Html(html)
}

/// Serve ReDoc documentation
async fn redoc_ui() -> Html<String> {
    let html = format!(
        r###"<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>HeliosDB Nano API Reference</title>
    <link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap" rel="stylesheet">
    <style>
        body {{
            margin: 0;
            padding: 0;
            font-family: 'Inter', sans-serif;
        }}
        .helios-header {{
            background: linear-gradient(135deg, #1a1a2e 0%, #16213e 100%);
            color: white;
            padding: 1rem 2rem;
            display: flex;
            align-items: center;
            gap: 1rem;
            position: sticky;
            top: 0;
            z-index: 100;
        }}
        .helios-header h1 {{
            margin: 0;
            font-size: 1.5rem;
            font-weight: 600;
        }}
        .helios-header .version {{
            background: #4f46e5;
            padding: 0.25rem 0.75rem;
            border-radius: 9999px;
            font-size: 0.875rem;
        }}
        .helios-header .links {{
            margin-left: auto;
            display: flex;
            gap: 1rem;
        }}
        .helios-header .links a {{
            color: white;
            text-decoration: none;
            opacity: 0.8;
            transition: opacity 0.2s;
        }}
        .helios-header .links a:hover {{
            opacity: 1;
        }}
    </style>
</head>
<body>
    <div class="helios-header">
        <h1>HeliosDB Nano</h1>
        <span class="version">v3.3.0</span>
        <div class="links">
            <a href="/v1/docs">Swagger UI</a>
            <a href="/v1/openapi.yaml">OpenAPI Spec</a>
            <a href="https://github.com/heliosdb/heliosdb-lite">GitHub</a>
        </div>
    </div>
    <redoc spec-url="/v1/openapi.json"
           hide-download-button="false"
           theme='{{"colors":{{"primary":{{"main":"#4f46e5"}}}}}}'
    ></redoc>
    <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
</body>
</html>"###
    );
    Html(html)
}

// Note: Tests for OpenAPI module moved to integration tests to avoid
// Rust 2021 prefix identifier parsing issues with string literals