Skip to content
Beskid Beskid

Beskid

Jump to a Beskid service

Beskid

Jump to a Beskid service

Integrate BSOL

BSOL is the Beskid Structured Object Language. Use it for a supported structured document. Do not use this page as a copy of a normative schema.

Identify the BSOL document family before you select a profile. Use the pinned BSOL source for implementation behavior. Use OpenSpec as the normative authority for required Beskid behavior.

The pinned BSOL source provides these embedded profile choices:

Document familyAvailable profile
Project manifestproject.v1 or project.v2
Workspace manifestworkspace.v1
Runtime manifestruntime.v1 or runtime.v2
Board layoutboard.v1, board.v2, or board.v3
Shell pagesshell.pages.v1
Tool configurationtools.config.v1
Shared configurationconfiguration.v1 or configuration.v2
Profile documentschema.v1 or schema.v2

This table identifies profiles. It does not reproduce their field rules.

  1. Choose the profile that matches the document family and supported version.
  2. Run beskid validate-bsol --profile project.v1 path/to/file.bproj with the selected profile in place of project.v1.
  3. Inspect each diagnostic with its source location and validation phase.

The command validates the document with the selected profile. A failure identifies a source location and gives a parse, schema, or semantic message.

Diagnostic phaseMeaning
ParseThe source does not form a BSOL document.
SchemaThe parsed document does not satisfy the selected profile.
SemanticA registered validation rule rejects the structured value.

For a parse diagnostic, correct the reported BSOL source location. For a schema diagnostic, confirm the document family and selected profile before you edit data. For a semantic diagnostic, use the rule name and source location to contact the validator owner.

If the profile behavior conflicts with OpenSpec, stop. Do not invent a corrected schema in Docs.

Author a template when the validated document belongs to a scaffold package.