Crate harmony_dsl

Crate harmony_dsl 

Source
Expand description

§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: Config 1.8.0 / Pipeline 1.8.0

§License

MIT License - See LICENSE file for details

Constants§

CONFIG_SCHEMA
The contents of the harmony-config-schema.toml file
PIPELINE_SCHEMA
The contents of the harmony-pipeline-schema.toml file