type-bridge-server 2.1.0

Query-intercepting proxy server for TypeDB with validation and audit logging
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

use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use type_bridge_core_lib::ast::Clause;

/// Request body for POST /query (structured AST).
#[derive(Debug, Deserialize)]
pub struct QueryRequest {
    /// Database override, or `None` to use the server default.
    pub database: Option<String>,
    /// Provider transaction mode requested by the caller.
    pub transaction_type: String,
    /// Structured query clauses to validate and execute.
    pub clauses: Vec<Clause>,
    /// Transport and application metadata exposed to interceptors.
    #[serde(default)]
    pub metadata: HashMap<String, serde_json::Value>,
}

/// Request body for POST /query/raw.
#[derive(Debug, Deserialize)]
pub struct RawQueryRequest {
    /// Database override, or `None` to use the server default.
    pub database: Option<String>,
    /// Provider transaction mode requested by the caller.
    pub transaction_type: String,
    /// Raw TypeQL query text to parse and execute.
    pub query: String,
    /// Transport and application metadata exposed to interceptors.
    #[serde(default)]
    pub metadata: HashMap<String, serde_json::Value>,
}

/// Request body for POST /query/validate.
#[derive(Debug, Deserialize)]
pub struct ValidateRequest {
    /// Structured query clauses to validate without execution.
    pub clauses: Vec<Clause>,
}

/// Successful query response.
#[derive(Debug, Serialize)]
pub struct QueryResponse {
    /// Stable response status, normally `ok`.
    pub status: String,
    /// Provider result encoded as JSON.
    pub results: serde_json::Value,
    /// Pipeline execution metadata.
    pub metadata: ResponseMetadata,
}

#[derive(Debug, Serialize)]
/// Metadata returned with a successful query result.
pub struct ResponseMetadata {
    /// Unique identifier assigned to the request.
    pub request_id: String,
    /// Whole-pipeline execution duration in milliseconds.
    pub execution_time_ms: u64,
    /// Interceptor names applied to the request, in request order.
    pub interceptors_applied: Vec<String>,
}

/// Validation response.
#[derive(Debug, Serialize)]
pub struct ValidateResponse {
    /// Stable response status, normally `ok`.
    pub status: String,
    /// Whether every supplied clause passed static validation.
    pub is_valid: bool,
    /// Validation findings encoded for the HTTP wire.
    pub errors: Vec<serde_json::Value>,
}

/// Health check response.
#[derive(Debug, Serialize)]
pub struct HealthResponse {
    /// Service health status.
    pub status: String,
    /// Released V1 HTTP contract version.
    pub version: String,
    /// Whether the configured TypeDB endpoint is reachable.
    pub typedb_connected: bool,
}