Skip to content

TaxonomyIndex

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.

Schema

Metadata (metadata)

FieldTypeRequiredDescription
idstringYesUnique identifier (e.g., global_taxonomy_index).
namestringYesName of the index.
descriptionstringYesExplanation of the scope of this taxonomy index.
versionstringYesSemantic version of the index.

Taxonomy Body (global / local)

Defines a list of taxonomies structured by scope (global or country-specific):

FieldTypeRequiredDescription
idstringYesCanonical ID of the taxonomy.
pathstringYesRelative path of the YAML file within ce-specs.
scopestringNoScope of application (e.g., GLOBAL or country codes).
statusstringYesLifecycle status (e.g., PRODUCTION, DRAFT).

Example Usage

apiVersion: colabedu.ai/v1beta1
kind: TaxonomyIndex
metadata:
id: global_taxonomy_index
name: "ColabEdu Global Taxonomy Index"
description: "Master index of all taxonomy YAML files."
version: "1.2.0"
global:
standards:
- id: std.ap.v1
path: catalog/global/taxonomy.std.ap.yaml
scope: GLOBAL
status: PRODUCTION