validate

Validate a SWML document against structural rules. Checks for required top-level keys (version, sections), valid version strings, a main section, and correct AI verb structure. Results are cached.

Parameters

Returns

ValidationResult — An object with valid: boolean and errors: string[].

Example

1
import { SchemaUtils } from '@signalwire/sdk';
2
3
const schema = new SchemaUtils();
4
const result = schema.validate({
5
  version: '1.0.0',
6
  sections: { main: [{ answer: {} }, { hangup: {} }] },
7
});
8
9
if (!result.valid) {
10
  console.error('Validation errors:', result.errors);
11
}