Schema Reference

Intuware publishes JSON schemas for every YAML configuration file in a project. These schemas power IDE autocompletion, inline validation, and AI-assisted configuration generation.

Available Schemas

Schema	Validates	URL
channel.schema.json	channel.yaml files	https://intu.dev/schema/channel.schema.json
profile.schema.json	intu.yaml and profile files	https://intu.dev/schema/profile.schema.json
intumessage.schema.json	.intuJSON message envelope	https://intu.dev/schema/intumessage.schema.json

Channel Schema

The channel schema validates every channel.yaml file in your project. It covers listeners, destinations, pipeline steps, transformer references, validator references, and all channel-level settings.

https://intu.dev/schema/channel.schema.json

Add the schema comment at the top of any channel.yaml for immediate IDE support:

# yaml-language-server: $schema=https://intu.dev/schema/channel.schema.json

name: adt-feed
description: ADT feed from HIS
listeners:
  - type: mllp
    port: 2575

Profile Schema

The profile schema validates the root intu.yaml as well as any profile override files (e.g. profiles/dev.yaml, profiles/prod.yaml). It covers dashboard config, message storage, Kafka, Redis, telemetry, secrets, audit, and all engine-level settings.

https://intu.dev/schema/profile.schema.json

# yaml-language-server: $schema=https://intu.dev/schema/profile.schema.json

dashboard:
  enabled: true
  port: 3001
message_storage:
  driver: postgres
  connection_string: ${DATABASE_URL}

IntuMessage Schema

The IntuMessage schema defines the structure of the .intuJSON envelope — the internal message format that flows through the pipeline. This is useful when writing transformers or inspecting messages in the dashboard.

https://intu.dev/schema/intumessage.schema.json

Note

You rarely need to reference this schema directly in YAML files. It is most useful when working with the REST API or writing tests that assert on message structure.

VS Code Setup

Install the YAML extension by Red Hat, then add schema associations to your workspace or user settings.json:

{
  "yaml.schemas": {
    "https://intu.dev/schema/channel.schema.json": "channels/*/channel.yaml",
    "https://intu.dev/schema/profile.schema.json": [
      "intu.yaml",
      "profiles/*.yaml"
    ]
  }
}

This gives you:

• Autocompletion for every property and enum value
• Inline validation with red squiggles on invalid keys or values
• Hover documentation describing each property

Tip

Projects created with intu init include a .vscode/settings.json with these schema mappings preconfigured.

Using with AI

Provide the schema URL to AI coding assistants so they generate correct configuration:

Use the JSON schema at https://intu.dev/schema/channel.schema.json when generating channel.yaml files for Intuware.

AI tools that support schema-aware generation (Cursor, GitHub Copilot, ChatGPT with browsing) will fetch the schema and constrain their output to valid configuration.

Tip

Paste the schema URL into your AI assistant’s system prompt or context for the best results.

Schema Versioning

Schemas are versioned in lockstep with the CLI. Each CLI release publishes a matching set of schemas.

CLI Version	Schema URL Pattern
Latest	https://intu.dev/schema/<name>.json
Pinned	https://intu.dev/schema/v/<version>/<name>.json

# Pin to a specific version
# yaml-language-server: $schema=https://intu.dev/schema/v/1.2.0/channel.schema.json

Caution

Always keep your schema version aligned with your installed CLI version. Mismatched schemas can flag valid configuration as errors or miss newly added properties.