OAS YAML Reference

ColabEdu’s OAS (Open Assessment Specification) v1beta1 architecture is entirely configured through a structured YAML file schema. This Assessment as Code approach allows for versioning, auditing, and reproducing the entire pedagogical ecosystem.

In this reference section, you will find detailed technical information about the structure, schemas, and configuration options for each of the Kinds (Resource Types) that make up the architecture.

---

Available Specification Types

Each YAML specification in ColabEdu requires certain mandatory fields in its base structure:

• apiVersion: Schema API version (currently colabedu.ai/v1beta1).
• kind: Resource type identifier.
• metadata: Metadata such as id, title, version, which help index the resource in the SpecManager.
• spec: Resource type-specific configuration.

Below is the reference documentation for each resource type:

Core Engine Resources

• Taxonomy: Defines geographical hierarchies, organizational levels, and competencies.
• SubjectArea: Specifies the classification of a subject at local and international levels.

Regulatory Resources (C0)

• Rubric: Immutable learning standards, evaluation criteria, and descriptors by level.

Instruments and Exercises (C1 and C2)

• Recipe: Assembler “recipe” that associates C0 competencies with exercise types and criteria to generate a C2 assessment.
• ExerciseSpec: Schema for a generated or manually defined assessment, ready to be solved.
• ExerciseType: Technical definition of the interaction format (e.g., free_text, multiple_choice).
• AssessmentItem: Atomic interactive assessment component, instantiated and packaged for the frontend.

ACA Orchestration and Curriculum

Resource	Description
CuratorPlan	Persistent ACA ingestion plan. Created by CLI or REST API. Tracks country, standard, status, items, and campaign configuration.
CurriculumRequirements	Curriculum requirements YAML (ce-specs/catalog/requirements/). Defines how many specs of each type (BLOCK_CONTENT, BLOCK_RUBRIC…) are needed per theme to complete a curriculum. Used by CurriculumGapAnalyzer.
Curator Batch YAML	Declarative pipeline file (ce-specs/batches/). Defines stages (discover, fetch, parse, approval, ingest) in a YAML and runs with spec batch run.

These are not standard OAS files

CuratorPlan lives in the database (table curator_plans), not in ce-specs.
CurriculumRequirements lives in ce-specs/catalog/requirements/, not in the pedagogical spec catalog.

Artificial Intelligence and Agents (C3)

• Directive: Immutable behavioral guidelines that limit or guide the LLM engine.
• Persona: System interaction profiles (e.g., Instructional Designer).
• Gem: Extended AI modules with embedded configuration and tools.