Skip to content

TaxonomyIndex

TaxonomyIndex ● ACTIVE
Contract: v0.9.4 • View Schema ↗
Specification Standard: Open Pedagogy Specification (OPS) ce-specs-registry: schemas/taxonomy/taxonomy.base.schema.yaml
⚡ Live Schema Contract Definition (Auto-synced from schemas/taxonomy/taxonomy.base.schema.yaml) ▼

Metadata Properties (metadata)

Field Type Required Description
id string Yes Canonical unique identifier for the taxonomy node (e.g. loc.es or std.lomloe.v1).
reference_code string Yes Standardized reference code used across curriculum specifications.
name string No Readable name of the taxonomy concept, country, or standard.
title string No Official title of the standard or educational level.
type string No Taxonomy type classifier (e.g. location_country, standard, subject_area).
category string No Faceted category discriminator (LOCATION, STANDARD, MASTERY_SCALES, COMPETENCY).
active boolean No Whether this taxonomy element is actively usable in curriculum pipelines.
countryRef string No ISO country code or global reference.
version string No Semantic version tag of the taxonomy definition.
📦 Canonical YAML Example (Auto-synced from examples/taxonomy/taxonomy.base.example.yaml) ▼
apiVersion: colabedu.ai/v1beta1
kind: Taxonomy
metadata:
  id: loc.es
  type: location_country
  active: true
  name: "España"
  flag: "🇪🇸"
  languages: ["es-ES"]
spec:
  regions:
    - id: loc.es.mad
      name: "Comunidad de Madrid"
      active: true
      flagAsset: "assets/flags/en/mad.svg"
    - id: loc.es.cat
      name: "Catalunya"
      active: true
      languages: ["ca-ES"]
      flagAsset: "assets/flags/en/cat.svg"
  orgLevels:
    - id: org.lvl.es.infantil
      name: "Infantil"
    - id: org.lvl.es.primaria
      name: "Primaria"

The TaxonomyIndex (Taxonomy Index) resource acts as the master registry of all taxonomy YAML files loaded into the database via TaxonomyService. It coordinates the ingestion and localization of standards (such as LOMLOE or TEKS) and international subject taxonomies.