Skip to main content

JSON Schema Validation

Atmos supports JSON Schema validation, which can validate the schema of configurations such as stacks, workflows, and vendoring manifests. JSON Schema is an industry standard and provides a vocabulary to annotate and validate JSON documents for correctness.

Example​

# Validate 's3-bucket' component using JSON Schema in the 'plat-ue2-prod' stack
atmos validate component s3-bucket -s plat-ue2-prod --schema-path s3-bucket/validate-s3-bucket-component.json --schema-type jsonschema

Configure Component Validation​

In atmos.yaml, add the schemas section:

atmos.yaml
# Validation schemas (for validating atmos stacks and components)
schemas:
  # https://json-schema.org
  jsonschema:
    # Can also be set using `ATMOS_SCHEMAS_JSONSCHEMA_BASE_PATH` ENV var, or `--schemas-jsonschema-dir` command-line arguments
    # Supports both absolute and relative paths
    base_path: "stacks/schemas/jsonschema"

In the component manifest, add the settings.validation section:

stacks/catalog/s3-bucket/defaults.yaml
components:
  terraform:
    s3-bucket:
      settings:
        validation:
          validate-s3-bucket-with-jsonschema:
            schema_type: jsonschema
            # 'schema_path' can be an absolute path or a path relative to 'schemas.jsonschema.base_path' defined in `atmos.yaml`
            schema_path: "s3-bucket/validate-s3-bucket-component.json"
            description: Validate 's3-bucket' variables using JSON Schema

Add the following JSON Schema in the file stacks/schemas/jsonschema/s3-bucket/validate-s3-bucket-component.json:

examples/quick-start-advanced/stacks/schemas/jsonschema/s3-bucket/validate-s3-bucket-component.json

Try It​

Explore a working example that demonstrates JSON Schema validation in action.

demo-schemasView full example
atmos validate schema
00:00.0 / 00:00.0

Example: Demo Schemas

Validate YAML files against JSON Schema before using them in your workflows.

Learn more about Validation.

What You'll See

Try It

cd examples/demo-schemas

# Validate all matched files against their schemas
atmos validate schema

Key Files

FilePurpose
atmos.yamlSchema definitions with three source types
manifest.jsonLocal JSON Schema file
config.yamlValidated against local schema
bower.yamlValidated against remote schema
inline.yamlValidated against inline schema
Browse all files