harmony-dsl 1.4.2

TOML Schema DSL definitions for Harmony Proxy configuration files
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

//! # harmony-dsl
//!
//! TOML Schema DSL definitions for Harmony Proxy configuration files.
//!
//! This crate contains schema definitions used for validating Harmony Proxy
//! configuration files:
//!
//! - `harmony-config-schema.toml` - Main gateway configuration schema
//! - `harmony-pipeline-schema.toml` - Pipeline configuration schema
//!
//! ## Usage
//!
//! These schema files are included in the crate and can be accessed by
//! consumers for validation purposes. The schema files are located in the
//! crate root and can be referenced when building validators.
//!
//! ## Schema Files
//!
//! ### harmony-config-schema.toml
//!
//! Defines the structure for main gateway configuration files (`config.toml`).
//! Includes validation rules for:
//! - Proxy settings (ID, logging, paths)
//! - Network definitions (HTTP listeners, WireGuard)
//! - Management API configuration
//! - Storage backends (filesystem, S3)
//! - Service type registry
//!
//! ### harmony-pipeline-schema.toml
//!
//! Defines the structure for pipeline configuration files (`pipelines/*.toml`).
//! Includes validation rules for:
//! - Pipeline routing definitions
//! - Endpoint configurations (how requests arrive)
//! - Backend configurations (where requests go)
//! - Middleware instances (transform, auth, etc.)
//!
//! ## Cross-Language Support
//!
//! These schemas are designed to work with both:
//! - **Rust** (harmony-proxy) - Local validation before proxy startup
//! - **PHP** (Runbeam Cloud API) - Remote validation and configuration management
//!
//! ## Version
//!
//! Schema version: 1.0
//!
//! ## License
//!
//! MIT License - See LICENSE file for details

/// The contents of the harmony-config-schema.toml file
pub const CONFIG_SCHEMA: &str = include_str!("../harmony-config-schema.toml");

/// The contents of the harmony-pipeline-schema.toml file
pub const PIPELINE_SCHEMA: &str = include_str!("../harmony-pipeline-schema.toml");

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn config_schema_is_not_empty() {
        assert!(!CONFIG_SCHEMA.is_empty());
        assert!(CONFIG_SCHEMA.contains("[schema]"));
    }

    #[test]
    fn pipeline_schema_is_not_empty() {
        assert!(!PIPELINE_SCHEMA.is_empty());
        assert!(PIPELINE_SCHEMA.contains("[schema]"));
    }
}