dapla-toolbelt-metadata 0.4.2__py3-none-any.whl → 0.6.0__py3-none-any.whl

dapla_metadata/variable_definitions/{generated → _generated}/vardef_client/models/update_draft.py

@@ -1,6 +1,6 @@
-"""Variable Definitions
+"""Internal Variable Definitions Administration API
 
-## Introduction  Variable Definitions are centralized definitions of concrete variables which are typically present in multiple datasets. Variable Definitions support standardization of data and metadata and facilitate sharing and joining of data by clarifying when variables have an identical definition.  ## Maintenance of Variable Definitions This API allows for creation, maintenance and access of Variable Definitions.  ### Ownership Creation and maintenance of variables may only be performed by Statistics Norway employees representing a specific Dapla team, who are defined as the owners of a given Variable Definition. The team an owner represents must be specified when making a request through the `active_group` query parameter. All maintenance is to be performed by the owners, with no intervention from administrators.  ### Status All Variable Definitions have an associated status. The possible values for status are `DRAFT`, `PUBLISHED_INTERNAL` and `PUBLISHED_EXTERNAL`.   #### Draft When a Variable Definition is created it is assigned the status `DRAFT`. Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Mutable (it may be changed directly without need for versioning). - Not suitable to refer to from other systems.  This status may be changed to `PUBLISHED_INTERNAL` or `PUBLISHED_EXTERNAL` with a direct update.  #### Published Internal Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Immutable (all changes are versioned). - Suitable to refer to in internal systems for statistics production. - Not suitable to refer to for external use (for example in Statistikkbanken).  This status may be changed to `PUBLISHED_EXTERNAL` by creating a Patch version.  #### Published External Under this status the Variable Definition is:  - Visible to the general public. - Immutable (all changes are versioned). - Suitable to refer to from any system.  This status may not be changed as it would break immutability. If a Variable Definition is no longer relevant then its period of validity should be ended by specifying a `valid_until` date in a Patch version.  ### Immutability Variable Definitions are immutable. This means that any changes must be performed in a strict versioning system. Consumers can avoid being exposed to breaking changes by specifying a `date_of_validity` when they request a Variable Definition.  #### Patches Patches are for changes which do not affect the fundamental meaning of the Variable Definition.  #### Validity Periods Validity Periods are versions with a period defined by a `valid_from` date and optionally a `valid_until` date. If the fundamental meaning of a Variable Definition is to be changed, it should be done by creating a new Validity Period.
+## Introduction  Variable Definitions are centralized definitions of concrete variables which are typically present in multiple datasets. Variable Definitions support standardization of data and metadata and facilitate sharing and joining of data by clarifying when variables have an identical definition.  ## Maintenance of Variable Definitions This API allows for creation, maintenance and access of Variable Definitions.  ### Ownership Creation and maintenance of variables may only be performed by Statistics Norway employees representing a specific Dapla team, who are defined as the owners of a given Variable Definition. The team an owner represents must be specified when making a request through the `active_group` query parameter. All maintenance is to be performed by the owners, with no intervention from administrators.  ### Status All Variable Definitions have an associated status. The possible values for status are `DRAFT`, `PUBLISHED_INTERNAL` and `PUBLISHED_EXTERNAL`.  #### Draft When a Variable Definition is created it is assigned the status `DRAFT`. Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Mutable (it may be changed directly without need for versioning). - Not suitable to refer to from other systems.  This status may be changed to `PUBLISHED_INTERNAL` or `PUBLISHED_EXTERNAL` with a direct update.  #### Published Internal Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Immutable (all changes are versioned). - Suitable to refer to in internal systems for statistics production. - Not suitable to refer to for external use (for example in Statistikkbanken).  This status may be changed to `PUBLISHED_EXTERNAL` by creating a Patch version.  #### Published External Under this status the Variable Definition is:  - Visible to the general public. - Immutable (all changes are versioned). - Suitable to refer to from any system.  This status may not be changed as it would break immutability. If a Variable Definition is no longer relevant then its period of validity should be ended by specifying a `valid_until` date in a Patch version.  ### Immutability Variable Definitions are immutable. This means that any changes must be performed in a strict versioning system. Consumers can avoid being exposed to breaking changes by specifying a `date_of_validity` when they request a Variable Definition.  #### Patches Patches are for changes which do not affect the fundamental meaning of the Variable Definition.  #### Validity Periods Validity Periods are versions with a period defined by a `valid_from` date and optionally a `valid_until` date. If the fundamental meaning of a Variable Definition is to be changed, it should be done by creating a new Validity Period.
 
 The version of the OpenAPI document: 0.1
 Contact: metadata@ssb.no
@@ -36,36 +36,31 @@ from ..models.variable_status import VariableStatus
 class UpdateDraft(BaseModel):
     """Update variable definition Data structure with all fields optional for updating a Draft Variable Definition."""
 
-    name: LanguageStringType | None = Field(
-        default=None,
-        description="Name of the variable. Must be unique for a given Unit Type and Owner combination.",
-    )
+    name: LanguageStringType | None = None
     short_name: Annotated[str, Field(strict=True)] | None = Field(
         default=None,
         description="Recommended short name. Must be unique within an organization.",
     )
-    definition: LanguageStringType | None = Field(
-        default=None, description="Definition of the variable."
-    )
+    definition: LanguageStringType | None = None
     classification_reference: StrictStr | None = Field(
         default=None,
         description="ID of a classification or code list from Klass. The given classification defines all possible values for the defined variable.",
     )
-    unit_types: list[StrictStr] | None = Field(
+    unit_types: list[Annotated[str, Field(min_length=1, strict=True)]] | None = Field(
         default=None,
         description="A list of one or more unit types, e.g. person, vehicle, household. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/702.",
     )
-    subject_fields: list[StrictStr] | None = Field(
-        default=None,
-        description="A list of subject fields that the variable is used in. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/618.",
+    subject_fields: list[Annotated[str, Field(min_length=1, strict=True)]] | None = (
+        Field(
+            default=None,
+            description="A list of subject fields that the variable is used in. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/618.",
+        )
     )
     contains_special_categories_of_personal_data: StrictBool | None = Field(
         default=None,
         description="True if variable instances contain particularly sensitive information. Applies even if the information or identifiers are pseudonymized. Information within the following categories are regarded as particularly sensitive: Ethnicity, Political alignment, Religion, Philosophical beliefs, Union membership, Genetics, Biometrics, Health, Sexual relations, Sexual orientation",
     )
-    variable_status: VariableStatus | None = Field(
-        default=None, description="Status of the life cycle of the variable"
-    )
+    variable_status: VariableStatus | None = None
     measurement_type: StrictStr | None = Field(
         default=None,
         description="Type of measurement for the variable, e.g. length, volume, currency. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/303",
@@ -74,22 +69,17 @@ class UpdateDraft(BaseModel):
         default=None,
         description="The variable definition is valid from this date inclusive",
     )
+    valid_until: date | None = None
     external_reference_uri: StrictStr | None = Field(
         default=None, description="A link (URI) to an external definition/documentation"
     )
-    comment: LanguageStringType | None = Field(
-        default=None,
-        description="Optional comment to explain the definition or communicate potential changes.",
-    )
+    comment: LanguageStringType | None = None
     related_variable_definition_uris: list[StrictStr] | None = Field(
         default=None,
         description="Link(s) to related definitions of variables - a list of one or more definitions. For example for a variable after-tax income it could be relevant to link to definitions of income from work, property income etc.",
     )
-    owner: Owner | None = Field(
-        default=None,
-        description="Owner of the definition, i.e. responsible Dapla team (statistics team) and information about access management groups.",
-    )
-    contact: Contact | None = Field(default=None, description="Contact details")
+    owner: Owner | None = None
+    contact: Contact | None = None
     __properties: ClassVar[list[str]] = [
         "name",
         "short_name",
@@ -101,6 +91,7 @@ class UpdateDraft(BaseModel):
         "variable_status",
         "measurement_type",
         "valid_from",
+        "valid_until",
         "external_reference_uri",
         "comment",
         "related_variable_definition_uris",
@@ -170,21 +161,11 @@ class UpdateDraft(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of contact
         if self.contact:
             _dict["contact"] = self.contact.to_dict()
-        # set to None if name (nullable) is None
-        # and model_fields_set contains the field
-        if self.name is None and "name" in self.model_fields_set:
-            _dict["name"] = None
-
         # set to None if short_name (nullable) is None
         # and model_fields_set contains the field
         if self.short_name is None and "short_name" in self.model_fields_set:
             _dict["short_name"] = None
 
-        # set to None if definition (nullable) is None
-        # and model_fields_set contains the field
-        if self.definition is None and "definition" in self.model_fields_set:
-            _dict["definition"] = None
-
         # set to None if classification_reference (nullable) is None
         # and model_fields_set contains the field
         if (
@@ -211,11 +192,6 @@ class UpdateDraft(BaseModel):
         ):
             _dict["contains_special_categories_of_personal_data"] = None
 
-        # set to None if variable_status (nullable) is None
-        # and model_fields_set contains the field
-        if self.variable_status is None and "variable_status" in self.model_fields_set:
-            _dict["variable_status"] = None
-
         # set to None if measurement_type (nullable) is None
         # and model_fields_set contains the field
         if (
@@ -229,6 +205,11 @@ class UpdateDraft(BaseModel):
         if self.valid_from is None and "valid_from" in self.model_fields_set:
             _dict["valid_from"] = None
 
+        # set to None if valid_until (nullable) is None
+        # and model_fields_set contains the field
+        if self.valid_until is None and "valid_until" in self.model_fields_set:
+            _dict["valid_until"] = None
+
         # set to None if external_reference_uri (nullable) is None
         # and model_fields_set contains the field
         if (
@@ -237,11 +218,6 @@ class UpdateDraft(BaseModel):
         ):
             _dict["external_reference_uri"] = None
 
-        # set to None if comment (nullable) is None
-        # and model_fields_set contains the field
-        if self.comment is None and "comment" in self.model_fields_set:
-            _dict["comment"] = None
-
         # set to None if related_variable_definition_uris (nullable) is None
         # and model_fields_set contains the field
         if (
@@ -250,16 +226,6 @@ class UpdateDraft(BaseModel):
         ):
             _dict["related_variable_definition_uris"] = None
 
-        # set to None if owner (nullable) is None
-        # and model_fields_set contains the field
-        if self.owner is None and "owner" in self.model_fields_set:
-            _dict["owner"] = None
-
-        # set to None if contact (nullable) is None
-        # and model_fields_set contains the field
-        if self.contact is None and "contact" in self.model_fields_set:
-            _dict["contact"] = None
-
         return _dict
 
     @classmethod
@@ -289,6 +255,7 @@ class UpdateDraft(BaseModel):
                 "variable_status": obj.get("variable_status"),
                 "measurement_type": obj.get("measurement_type"),
                 "valid_from": obj.get("valid_from"),
+                "valid_until": obj.get("valid_until"),
                 "external_reference_uri": obj.get("external_reference_uri"),
                 "comment": LanguageStringType.from_dict(obj["comment"])
                 if obj.get("comment") is not None

dapla_metadata/variable_definitions/{generated → _generated}/vardef_client/models/validity_period.py

@@ -1,6 +1,6 @@
-"""Variable Definitions
+"""Internal Variable Definitions Administration API
 
-## Introduction  Variable Definitions are centralized definitions of concrete variables which are typically present in multiple datasets. Variable Definitions support standardization of data and metadata and facilitate sharing and joining of data by clarifying when variables have an identical definition.  ## Maintenance of Variable Definitions This API allows for creation, maintenance and access of Variable Definitions.  ### Ownership Creation and maintenance of variables may only be performed by Statistics Norway employees representing a specific Dapla team, who are defined as the owners of a given Variable Definition. The team an owner represents must be specified when making a request through the `active_group` query parameter. All maintenance is to be performed by the owners, with no intervention from administrators.  ### Status All Variable Definitions have an associated status. The possible values for status are `DRAFT`, `PUBLISHED_INTERNAL` and `PUBLISHED_EXTERNAL`.   #### Draft When a Variable Definition is created it is assigned the status `DRAFT`. Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Mutable (it may be changed directly without need for versioning). - Not suitable to refer to from other systems.  This status may be changed to `PUBLISHED_INTERNAL` or `PUBLISHED_EXTERNAL` with a direct update.  #### Published Internal Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Immutable (all changes are versioned). - Suitable to refer to in internal systems for statistics production. - Not suitable to refer to for external use (for example in Statistikkbanken).  This status may be changed to `PUBLISHED_EXTERNAL` by creating a Patch version.  #### Published External Under this status the Variable Definition is:  - Visible to the general public. - Immutable (all changes are versioned). - Suitable to refer to from any system.  This status may not be changed as it would break immutability. If a Variable Definition is no longer relevant then its period of validity should be ended by specifying a `valid_until` date in a Patch version.  ### Immutability Variable Definitions are immutable. This means that any changes must be performed in a strict versioning system. Consumers can avoid being exposed to breaking changes by specifying a `date_of_validity` when they request a Variable Definition.  #### Patches Patches are for changes which do not affect the fundamental meaning of the Variable Definition.  #### Validity Periods Validity Periods are versions with a period defined by a `valid_from` date and optionally a `valid_until` date. If the fundamental meaning of a Variable Definition is to be changed, it should be done by creating a new Validity Period.
+## Introduction  Variable Definitions are centralized definitions of concrete variables which are typically present in multiple datasets. Variable Definitions support standardization of data and metadata and facilitate sharing and joining of data by clarifying when variables have an identical definition.  ## Maintenance of Variable Definitions This API allows for creation, maintenance and access of Variable Definitions.  ### Ownership Creation and maintenance of variables may only be performed by Statistics Norway employees representing a specific Dapla team, who are defined as the owners of a given Variable Definition. The team an owner represents must be specified when making a request through the `active_group` query parameter. All maintenance is to be performed by the owners, with no intervention from administrators.  ### Status All Variable Definitions have an associated status. The possible values for status are `DRAFT`, `PUBLISHED_INTERNAL` and `PUBLISHED_EXTERNAL`.  #### Draft When a Variable Definition is created it is assigned the status `DRAFT`. Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Mutable (it may be changed directly without need for versioning). - Not suitable to refer to from other systems.  This status may be changed to `PUBLISHED_INTERNAL` or `PUBLISHED_EXTERNAL` with a direct update.  #### Published Internal Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Immutable (all changes are versioned). - Suitable to refer to in internal systems for statistics production. - Not suitable to refer to for external use (for example in Statistikkbanken).  This status may be changed to `PUBLISHED_EXTERNAL` by creating a Patch version.  #### Published External Under this status the Variable Definition is:  - Visible to the general public. - Immutable (all changes are versioned). - Suitable to refer to from any system.  This status may not be changed as it would break immutability. If a Variable Definition is no longer relevant then its period of validity should be ended by specifying a `valid_until` date in a Patch version.  ### Immutability Variable Definitions are immutable. This means that any changes must be performed in a strict versioning system. Consumers can avoid being exposed to breaking changes by specifying a `date_of_validity` when they request a Variable Definition.  #### Patches Patches are for changes which do not affect the fundamental meaning of the Variable Definition.  #### Validity Periods Validity Periods are versions with a period defined by a `valid_from` date and optionally a `valid_until` date. If the fundamental meaning of a Variable Definition is to be changed, it should be done by creating a new Validity Period.
 
 The version of the OpenAPI document: 0.1
 Contact: metadata@ssb.no
@@ -15,6 +15,7 @@ import json
 import pprint
 import re  # noqa: F401
 from datetime import date
+from typing import Annotated
 from typing import Any
 from typing import ClassVar
 
@@ -27,36 +28,31 @@ from typing_extensions import Self
 
 from ..models.contact import Contact
 from ..models.language_string_type import LanguageStringType
-from ..models.variable_status import VariableStatus
 
 
 class ValidityPeriod(BaseModel):
     """Create a new Validity Period on a Published Variable Definition."""
 
-    name: LanguageStringType | None = Field(
-        default=None,
-        description="Name of the variable. Must be unique for a given Unit Type and Owner combination.",
-    )
-    definition: LanguageStringType = Field(description="Definition of the variable.")
+    name: LanguageStringType | None = None
+    definition: LanguageStringType
     classification_reference: StrictStr | None = Field(
         default=None,
         description="ID of a classification or code list from Klass. The given classification defines all possible values for the defined variable.",
     )
-    unit_types: list[StrictStr] | None = Field(
+    unit_types: list[Annotated[str, Field(min_length=1, strict=True)]] | None = Field(
         default=None,
         description="A list of one or more unit types, e.g. person, vehicle, household. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/702.",
     )
-    subject_fields: list[StrictStr] | None = Field(
-        default=None,
-        description="A list of subject fields that the variable is used in. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/618.",
+    subject_fields: list[Annotated[str, Field(min_length=1, strict=True)]] | None = (
+        Field(
+            default=None,
+            description="A list of subject fields that the variable is used in. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/618.",
+        )
     )
     contains_special_categories_of_personal_data: StrictBool | None = Field(
         default=None,
         description="True if variable instances contain particularly sensitive information. Applies even if the information or identifiers are pseudonymized. Information within the following categories are regarded as particularly sensitive: Ethnicity, Political alignment, Religion, Philosophical beliefs, Union membership, Genetics, Biometrics, Health, Sexual relations, Sexual orientation",
     )
-    variable_status: VariableStatus | None = Field(
-        default=None, description="Status of the life cycle of the variable"
-    )
     measurement_type: StrictStr | None = Field(
         default=None,
         description="Type of measurement for the variable, e.g. length, volume, currency. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/303",
@@ -67,15 +63,12 @@ class ValidityPeriod(BaseModel):
     external_reference_uri: StrictStr | None = Field(
         default=None, description="A link (URI) to an external definition/documentation"
     )
-    comment: LanguageStringType | None = Field(
-        default=None,
-        description="Optional comment to explain the definition or communicate potential changes.",
-    )
+    comment: LanguageStringType | None = None
     related_variable_definition_uris: list[StrictStr] | None = Field(
         default=None,
         description="Link(s) to related definitions of variables - a list of one or more definitions. For example for a variable after-tax income it could be relevant to link to definitions of income from work, property income etc.",
     )
-    contact: Contact | None = Field(default=None, description="Contact details")
+    contact: Contact | None = None
     __properties: ClassVar[list[str]] = [
         "name",
         "definition",
@@ -83,7 +76,6 @@ class ValidityPeriod(BaseModel):
         "unit_types",
         "subject_fields",
         "contains_special_categories_of_personal_data",
-        "variable_status",
         "measurement_type",
         "valid_from",
         "external_reference_uri",
@@ -121,13 +113,8 @@ class ValidityPeriod(BaseModel):
         * `None` is only added to the output dict for nullable fields that
           were set at model initialization. Other fields with value `None`
           are ignored.
-        * OpenAPI `readOnly` fields are excluded.
         """
-        excluded_fields: set[str] = set(
-            [
-                "variable_status",
-            ]
-        )
+        excluded_fields: set[str] = set([])
 
         _dict = self.model_dump(
             by_alias=True,
@@ -146,11 +133,6 @@ class ValidityPeriod(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of contact
         if self.contact:
             _dict["contact"] = self.contact.to_dict()
-        # set to None if name (nullable) is None
-        # and model_fields_set contains the field
-        if self.name is None and "name" in self.model_fields_set:
-            _dict["name"] = None
-
         # set to None if classification_reference (nullable) is None
         # and model_fields_set contains the field
         if (
@@ -177,11 +159,6 @@ class ValidityPeriod(BaseModel):
         ):
             _dict["contains_special_categories_of_personal_data"] = None
 
-        # set to None if variable_status (nullable) is None
-        # and model_fields_set contains the field
-        if self.variable_status is None and "variable_status" in self.model_fields_set:
-            _dict["variable_status"] = None
-
         # set to None if measurement_type (nullable) is None
         # and model_fields_set contains the field
         if (
@@ -198,11 +175,6 @@ class ValidityPeriod(BaseModel):
         ):
             _dict["external_reference_uri"] = None
 
-        # set to None if comment (nullable) is None
-        # and model_fields_set contains the field
-        if self.comment is None and "comment" in self.model_fields_set:
-            _dict["comment"] = None
-
         # set to None if related_variable_definition_uris (nullable) is None
         # and model_fields_set contains the field
         if (
@@ -211,11 +183,6 @@ class ValidityPeriod(BaseModel):
         ):
             _dict["related_variable_definition_uris"] = None
 
-        # set to None if contact (nullable) is None
-        # and model_fields_set contains the field
-        if self.contact is None and "contact" in self.model_fields_set:
-            _dict["contact"] = None
-
         return _dict
 
     @classmethod
@@ -241,7 +208,6 @@ class ValidityPeriod(BaseModel):
                 "contains_special_categories_of_personal_data": obj.get(
                     "contains_special_categories_of_personal_data"
                 ),
-                "variable_status": obj.get("variable_status"),
                 "measurement_type": obj.get("measurement_type"),
                 "valid_from": obj.get("valid_from"),
                 "external_reference_uri": obj.get("external_reference_uri"),

dapla_metadata/variable_definitions/_generated/vardef_client/models/variable_status.py

@@ -0,0 +1,33 @@
+"""Internal Variable Definitions Administration API
+
+## Introduction  Variable Definitions are centralized definitions of concrete variables which are typically present in multiple datasets. Variable Definitions support standardization of data and metadata and facilitate sharing and joining of data by clarifying when variables have an identical definition.  ## Maintenance of Variable Definitions This API allows for creation, maintenance and access of Variable Definitions.  ### Ownership Creation and maintenance of variables may only be performed by Statistics Norway employees representing a specific Dapla team, who are defined as the owners of a given Variable Definition. The team an owner represents must be specified when making a request through the `active_group` query parameter. All maintenance is to be performed by the owners, with no intervention from administrators.  ### Status All Variable Definitions have an associated status. The possible values for status are `DRAFT`, `PUBLISHED_INTERNAL` and `PUBLISHED_EXTERNAL`.  #### Draft When a Variable Definition is created it is assigned the status `DRAFT`. Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Mutable (it may be changed directly without need for versioning). - Not suitable to refer to from other systems.  This status may be changed to `PUBLISHED_INTERNAL` or `PUBLISHED_EXTERNAL` with a direct update.  #### Published Internal Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Immutable (all changes are versioned). - Suitable to refer to in internal systems for statistics production. - Not suitable to refer to for external use (for example in Statistikkbanken).  This status may be changed to `PUBLISHED_EXTERNAL` by creating a Patch version.  #### Published External Under this status the Variable Definition is:  - Visible to the general public. - Immutable (all changes are versioned). - Suitable to refer to from any system.  This status may not be changed as it would break immutability. If a Variable Definition is no longer relevant then its period of validity should be ended by specifying a `valid_until` date in a Patch version.  ### Immutability Variable Definitions are immutable. This means that any changes must be performed in a strict versioning system. Consumers can avoid being exposed to breaking changes by specifying a `date_of_validity` when they request a Variable Definition.  #### Patches Patches are for changes which do not affect the fundamental meaning of the Variable Definition.  #### Validity Periods Validity Periods are versions with a period defined by a `valid_from` date and optionally a `valid_until` date. If the fundamental meaning of a Variable Definition is to be changed, it should be done by creating a new Validity Period.
+
+The version of the OpenAPI document: 0.1
+Contact: metadata@ssb.no
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""
+
+from __future__ import annotations
+
+import json
+from enum import Enum
+
+from typing_extensions import Self
+
+
+class VariableStatus(str, Enum):
+    """Life cycle status of a variable definition."""
+
+    """
+    allowed enum values
+    """
+    DRAFT = "DRAFT"
+    PUBLISHED_INTERNAL = "PUBLISHED_INTERNAL"
+    PUBLISHED_EXTERNAL = "PUBLISHED_EXTERNAL"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of VariableStatus from a JSON string"""
+        return cls(json.loads(json_str))

dapla_metadata/variable_definitions/_utils/__init__.py

@@ -0,0 +1 @@
+"""Util methods for variable definitions."""

dapla_metadata/variable_definitions/{_client.py → _utils/_client.py}

@@ -1,10 +1,12 @@
-from dapla_metadata.variable_definitions.config import get_vardef_client_configuration
-from dapla_metadata.variable_definitions.generated.vardef_client.api_client import (
+from dapla_metadata.variable_definitions._generated.vardef_client.api_client import (
     ApiClient,
 )
-from dapla_metadata.variable_definitions.generated.vardef_client.configuration import (
+from dapla_metadata.variable_definitions._generated.vardef_client.configuration import (
     Configuration,
 )
+from dapla_metadata.variable_definitions._utils.config import (
+    get_vardef_client_configuration,
+)
 
 
 class VardefClient:

dapla_metadata/variable_definitions/{config.py → _utils/config.py}

@@ -3,11 +3,35 @@ from dapla_metadata._shared.config import get_dapla_environment
 from dapla_metadata._shared.config import get_dapla_group_context
 from dapla_metadata._shared.config import get_oidc_token
 from dapla_metadata._shared.enums import DaplaEnvironment
-from dapla_metadata.variable_definitions.generated.vardef_client.configuration import (
+from dapla_metadata.variable_definitions._generated.vardef_client.configuration import (
     Configuration,
 )
 
 VARDEF_HOST_TEST = "https://metadata.intern.test.ssb.no"
+WORKSPACE_DIR = "WORKSPACE_DIR"
+VARDEF_DESCRIPTIONS_FILE_PATH = "VARDEF_DESCRIPTIONS_FILE_PATH"
+VARDEF_DEFAULT_DESCRIPTION_PATH = (
+    "variable_definitions/resources/vardef_model_descriptions_nb.yaml"
+)
+
+
+def get_descriptions_path() -> str:
+    """Get the relative file path from the repo root to the Norwegian descriptions.
+
+    First checks the `VARDEF_DESCRIPTIONS_FILE_PATH` environment variable; if not set, returns a default path.
+
+    Returns:
+        str: The file path to the descriptions.
+    """
+    return (
+        get_config_item(VARDEF_DESCRIPTIONS_FILE_PATH)
+        or VARDEF_DEFAULT_DESCRIPTION_PATH
+    )
+
+
+def get_workspace_dir() -> str | None:
+    """Get the path to work directory from workspace environment variable."""
+    return get_config_item(WORKSPACE_DIR)
 
 
 def get_active_group() -> str:

dapla_metadata/variable_definitions/_utils/constants.py

@@ -0,0 +1,41 @@
+"""Constants for variable definitions."""
+
+from datetime import date
+
+VARIABLE_DEFINITIONS_DIR = "variable_definitions"
+
+VARIABLE_STATUS_FIELD_NAME = "variable_status"
+OWNER_FIELD_NAME = "owner"
+
+TEMPLATE_HEADER = "--- Variabeldefinisjon mal ---\n"
+HEADER = "--- Variabeldefinisjon ---\n"
+
+TEMPLATE_SECTION_HEADER_STATUS = "\n--- Statusfelt. Verdi 'DRAFT' før publisering. Ikke rediger hvis du oppretter en ny variabeldefinisjon. ---\n"
+TEMPLATE_SECTION_HEADER_OWNER = "\n--- Eierteam og grupper. Ikke rediger hvis du oppretter en ny variabeldefinisjon, verdien genereres ---\n"
+TEMPLATE_SECTION_HEADER_MACHINE_GENERATED = (
+    "\n--- Maskin-genererte felt. Ikke rediger. ---\n"
+)
+
+TEMPLATE_HEADER_EN = "--- Variable definition template ---\n"
+HEADER_EN = "--- Variable definition ---\n"
+TEMPLATE_SECTION_HEADER_STATUS_EN = "\n--- Status field. Value 'DRAFT' before publishing. Do not edit if creating new variable defintion ---\n"
+TEMPLATE_SECTION_HEADER_OWNER_EN = "\n--- Owner team and groups. Do not edit if creating new variable defintion, value is generated ---\n"
+TEMPLATE_SECTION_HEADER_MACHINE_GENERATED_EN = (
+    "\n--- Machine generated fields. Do not edit ---\n"
+)
+
+NORWEGIAN_DESCRIPTIONS = "norwegian_description"
+
+DEFAULT_DATE = date(1000, 1, 1)
+
+MACHINE_GENERATED_FIELDS = [
+    "id",
+    "patch_id",
+    "created_at",
+    "created_by",
+    "last_updated_at",
+    "last_updated_by",
+]
+
+OPTIONAL_FIELD = "~ Valgfritt felt ~"
+REQUIRED_FIELD = "! Obligatorisk felt !"

dapla_metadata/variable_definitions/_utils/descriptions.py

@@ -0,0 +1,89 @@
+"""Utilities for dynamically adding extra fields to Pydantic models, specifically Norwegian descriptions."""
+
+import logging
+from pathlib import Path
+from typing import TYPE_CHECKING
+from typing import cast
+
+import ruamel.yaml
+from pydantic import BaseModel
+from pydantic import Field
+
+from dapla_metadata.variable_definitions._utils.config import get_descriptions_path
+
+if TYPE_CHECKING:
+    from pydantic.config import JsonDict
+
+logger = logging.getLogger(__name__)
+
+
+def get_package_root() -> Path:
+    """Get an absolute Path to the root of the package (dapla_metadata)."""
+    number_of_directories_up_from_descriptions_file = 2
+    return (
+        Path(__file__)
+        .resolve()
+        .parents[number_of_directories_up_from_descriptions_file]
+    )
+
+
+def load_descriptions(file_path: Path) -> dict:
+    """Load and return the contents of a YAML file as a dictionary.
+
+    Args:
+        file_path (Path): Path to the YAML file.
+
+    Returns:
+    dict: Parsed contents of the YAML file.
+    """
+    with Path.open(file_path, encoding="utf-8") as f:
+        return ruamel.yaml.YAML().load(f)
+
+
+def apply_norwegian_descriptions_to_model(
+    model: type[BaseModel],
+) -> None:
+    """Add Norwegian descriptions to the fields of a Pydantic model.
+
+    This function globally modifies the model fields by inserting a Norwegian description
+    from a predefined dictionary. If a field does not have a corresponding
+    Norwegian description, a default message is used.
+
+    Args:
+        model (BaseModel): A Pydantic model instance to be updated.
+
+    Returns:
+        None: The function modifies the model in place.
+    """
+    new_fields = {}
+
+    descriptions = load_descriptions(
+        get_package_root() / get_descriptions_path(),
+    )
+
+    for field_name, field_info in model.model_fields.items():
+        new_description: str = descriptions.get(
+            field_name,
+            f"No description in norwegian found for {field_name}",
+        )
+        if "No description in norwegian found" in new_description:
+            logger.warning("Missing description for %s", field_name)
+        else:
+            logger.debug("Field %s: %s", field_name, new_description)
+
+        new_fields[field_name] = Field(  # type: ignore[call-overload]
+            default=field_info.default,
+            alias=field_info.alias,
+            title=field_info.title,
+            description=field_info.description,
+            json_schema_extra=cast(
+                "JsonDict",
+                {
+                    "norwegian_description": new_description,
+                    "annotation": field_info.annotation,
+                },
+            ),
+        )
+
+    model.model_fields.update(new_fields)  # Apply changes
+    model.model_rebuild()