Skip to content

YAML Validation

Catch the typo before the run.

curl-runner validate checks every file against the schema: unknown keys with suggestions, invalid values, risky settings. --fix repairs what it safely can, and --strict turns warnings into failures.

user.yaml
# curl-runner validate --strict tests/
#   ● request.timout: Unknown key "timout" (did you mean "timeout"?)
#     fix: Rename to "timeout"
request:
  name: Get user
  url: https://api.example.com/users/1
  timeout: 5000
  expect:
    status: 200

Benefits

  • Suggestions, not just errors

    A misspelled key comes back with the key you meant, and the path to find it.

  • Auto-fix

    --fix renames misspelled keys and normalises values in place where the fix is unambiguous.

  • A gate for CI

    Run validate --strict before the suite so a broken file fails fast with a clear message.

Good for

  1. Pre-commit hooks
  2. A first CI step before the real run
  3. Reviewing files written by hand or by tools
  4. Migrating a large suite to a new version