docs: document public sdk contract helpers

This commit is contained in:
Peter Steinberger
2026-06-04 22:13:13 -04:00
parent b311fd607f
commit 848f39e70d
4 changed files with 64 additions and 5 deletions

View File

@@ -462,11 +462,17 @@ import {
WizardStepSchema,
} from "./schema.js";
/** Normalized validation error shape exposed by every protocol validator. */
export type ValidationError = {
/** Failed schema keyword, when the validator can report one. */
keyword?: string;
/** JSON-pointer path to the failing data location. */
instancePath?: string;
/** JSON-pointer path to the failing schema location. */
schemaPath?: string;
/** Validator-specific keyword parameters for richer diagnostics. */
params?: Record<string, unknown>;
/** Human-readable validation message. */
message?: string;
};