JSON Schema files

These JSON schema files are generated from the Pydantic models in src/deploy_tools/models. The YAML language server and other tooling use them to validate deployment configuration files. This section links to per-schema reference pages that render each schema and list its properties.

Which file uses which schema

You author two kinds of configuration file, each validated against a different schema:

Configuration file	Schema	Pydantic model
settings.yaml (one per config folder)	deployment-settings.json	DeploymentSettings
<name>/<version>.yaml (one per Module version)	release.json	Release

Per-version files sit in a folder named after the Module, so the path is <config folder>/<name>/<version>.yaml (folder = Module name, filename = version). Add a yaml-language-server comment as the first line of each file, pointing at the matching schema, so your editor validates it as you type:

# yaml-language-server: $schema=https://raw.githubusercontent.com/DiamondLightSource/deploy-tools/main/src/deploy_tools/models/schemas/release.json

This requires an editor with a YAML language server — e.g. VS Code with the Red Hat YAML extension, or any LSP-capable editor running yaml-language-server.

The other two generated schemas cover files you don’t normally author by hand: deployment.json (the deployment.yaml snapshot written by sync) and module.json (the Module that a Release wraps).

Schema pages

• DeploymentSettings
• Release

How the schemas are generated

deploy_tools.models.schema.generate_schema writes these files from the corresponding Pydantic models. To regenerate them manually:

deploy-tools schema path/to/output/folder