Source code for dsgrid.config.supplemental_dimension

"""Defines a supplemental dimension."""

from typing import Annotated
from pydantic import Field


from dsgrid.data_models import DSGBaseModel
from .dimensions import DimensionModel
from .mapping_tables import MappingTableByNameModel


class SupplementalDimensionModel(DimensionModel):
    """Defines a supplemental dimension."""

    mapping: MappingTableByNameModel = Field(
        description="Defines how the supplemental dimension will be mapped to the project's base "
        "dimension.",
        title="mapping",
    )




class SupplementalDimensionsListModel(DSGBaseModel):
    """Defines a list of supplemental dimensions."""

    supplemental_dimensions: Annotated[
        list[SupplementalDimensionModel], Field(min_length=1)
    ] = Field(
        description="List of supplemental dimensions and mappings to be registered",
    )