BioPath
Back to Scholarships Lab
Schema Reference

Lab Coach Schema Changelog

Every change to the Lab Coach API contract, documented with breaking changes, additive fields, and compatibility notes.

Current version1.0
v1. 02025-01-15

Initial lab coach wire schema with server-side enforcement, client runtime guards, and validation error reporting.

Breaking Changes
  • Required fields: labSummary, alignment, suggestedOpening must be non-empty strings.
  • fitScore must be an integer between 0 and 100.
  • Server enforces normalizeLabResult before every response regardless of debug flag.
  • Client runtime guard (validateLabResult) rejects incomplete payloads with a clear bilingual error.
Additive / New Fields
  • Optional piAnalysis block (PI metrics, themes, methods, trajectory).
  • Optional cvFit block (verdict, matchScore, matching/missing skills, actions).
  • validationReasons array in server responses for production diagnostics.
  • synthesizedSections array indicating which fields were auto-repaired.
  • schemaVersion top-level field for forward compatibility checks.
Compatibility Notes

This release establishes the API contract. Future minor versions may add optional fields without breaking existing clients. Major bumps require a page refresh.

How compatibility works

Match

Server and client versions are identical. Full feature set is available with no warnings.

Minor Drift

Server is ahead by a minor version. New optional fields may be present. The UI renders normally and logs a warning.

Incompatible

Major version mismatch or missing version. The UI refuses to render and shows an upgrade-required error.

Want to explore the schema?

The full client-side schema and validation logic lives in src/lib/lab-coach.schema.ts.

Try Scholarships Lab