From f17a3917c7f7fd2ab70ea9dae33a94c3d95b4f35 Mon Sep 17 00:00:00 2001 From: Leon Haffmans <49658102+lord-haffi@users.noreply.github.com> Date: Tue, 30 Jul 2024 12:47:37 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=A9=B9Fix=20circular=20import=20issue=20(?= =?UTF-8?q?#100)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 🩹Fix circular import issue * 🩹tests --- src/bo4e_generator/__main__.py | 12 +- src/bo4e_generator/imports.py | 129 +++++++++ src/bo4e_generator/parser.py | 59 ++++- .../bo4e_schemas/ZusatzAttribut.json | 4 +- .../test_data/bo4e_schemas/bo/Angebot.json | 20 +- .../bo4e_schemas/bo/Ausschreibung.json | 16 +- .../bo4e_schemas/bo/Buendelvertrag.json | 20 +- .../bo4e_schemas/bo/Energiemenge.json | 10 +- .../bo4e_schemas/bo/Fremdkosten.json | 10 +- .../test_data/bo4e_schemas/bo/Geraet.json | 11 +- .../bo4e_schemas/bo/Geschaeftsobjekt.json | 58 ---- .../bo4e_schemas/bo/Geschaeftspartner.json | 89 +++++-- .../test_data/bo4e_schemas/bo/Kosten.json | 11 +- .../test_data/bo4e_schemas/bo/Lastgang.json | 11 +- .../bo4e_schemas/bo/Lokationszuordnung.json | 179 +++++++++++++ .../bo4e_schemas/bo/Marktlokation.json | 117 +++++++- .../bo4e_schemas/bo/Marktteilnehmer.json | 181 ++----------- .../bo4e_schemas/bo/Messlokation.json | 44 ++- .../bo4e_schemas/bo/Netzlokation.json | 206 +++++++++++++++ .../bo/{Ansprechpartner.json => Person.json} | 60 +++-- .../test_data/bo4e_schemas/bo/Preisblatt.json | 13 +- .../bo/PreisblattDienstleistung.json | 17 +- .../bo4e_schemas/bo/PreisblattHardware.json | 18 +- .../bo/PreisblattKonzessionsabgabe.json | 14 +- .../bo4e_schemas/bo/PreisblattMessung.json | 18 +- .../bo/PreisblattNetznutzung.json | 15 +- .../test_data/bo4e_schemas/bo/Rechnung.json | 33 ++- .../test_data/bo4e_schemas/bo/Region.json | 10 +- .../bo4e_schemas/bo/Regionaltarif.json | 19 +- .../bo/Standorteigenschaften.json | 9 +- .../bo4e_schemas/bo/SteuerbareRessource.json | 156 +++++++++++ .../test_data/bo4e_schemas/bo/Tarif.json | 26 +- .../test_data/bo4e_schemas/bo/Tarifinfo.json | 20 +- .../bo4e_schemas/bo/Tarifkosten.json | 20 +- .../bo4e_schemas/bo/Tarifpreisblatt.json | 26 +- .../bo4e_schemas/bo/TechnischeRessource.json | 250 ++++++++++++++++++ .../test_data/bo4e_schemas/bo/Vertrag.json | 18 +- .../test_data/bo4e_schemas/bo/Zaehler.json | 26 +- .../test_data/bo4e_schemas/bo/Zeitreihe.json | 13 +- .../test_data/bo4e_schemas/com/Adresse.json | 15 +- .../bo4e_schemas/com/Angebotsposition.json | 10 +- .../bo4e_schemas/com/Angebotsteil.json | 12 +- .../bo4e_schemas/com/Angebotsvariante.json | 12 +- .../bo4e_schemas/com/AufAbschlag.json | 14 +- .../bo4e_schemas/com/AufAbschlagProOrt.json | 10 +- .../bo4e_schemas/com/AufAbschlagRegional.json | 21 +- .../com/AufAbschlagstaffelProOrt.json | 18 +- .../com/Ausschreibungsdetail.json | 21 +- .../bo4e_schemas/com/Ausschreibungslos.json | 23 +- .../test_data/bo4e_schemas/com/Betrag.json | 11 +- unittests/test_data/bo4e_schemas/com/COM.json | 47 ---- .../bo4e_schemas/com/Dienstleistung.json | 8 +- .../bo4e_schemas/com/Energieherkunft.json | 11 +- .../bo4e_schemas/com/Energiemix.json | 24 +- .../bo4e_schemas/com/Fremdkostenblock.json | 9 +- .../bo4e_schemas/com/Fremdkostenposition.json | 19 +- .../bo4e_schemas/com/Geokoordinaten.json | 12 +- .../bo4e_schemas/com/Katasteradresse.json | 6 +- ...rdnung.json => Konfigurationsprodukt.json} | 30 +-- .../bo4e_schemas/com/Kontaktweg.json | 100 +++++++ .../bo4e_schemas/com/Konzessionsabgabe.json | 12 +- .../bo4e_schemas/com/Kostenblock.json | 9 +- .../bo4e_schemas/com/Kostenposition.json | 15 +- .../bo4e_schemas/com/KriteriumWert.json | 8 +- .../bo4e_schemas/com/MarktgebietInfo.json | 8 +- .../test_data/bo4e_schemas/com/Menge.json | 11 +- .../com/PositionsAufAbschlag.json | 14 +- .../test_data/bo4e_schemas/com/Preis.json | 13 +- .../bo4e_schemas/com/Preisgarantie.json | 9 +- .../bo4e_schemas/com/Preisposition.json | 25 +- .../bo4e_schemas/com/Preisstaffel.json | 19 +- .../bo4e_schemas/com/Rechnungsposition.json | 20 +- .../com/RegionaleGueltigkeit.json | 8 +- .../com/RegionalePreisgarantie.json | 10 +- .../com/RegionalePreisstaffel.json | 20 +- .../com/RegionaleTarifpreisposition.json | 11 +- .../com/RegionalerAufAbschlag.json | 21 +- .../bo4e_schemas/com/Regionskriterium.json | 9 +- .../test_data/bo4e_schemas/com/Rufnummer.json | 70 ----- .../bo4e_schemas/com/Sigmoidparameter.json | 22 +- .../com/StandorteigenschaftenGas.json | 8 +- .../com/StandorteigenschaftenStrom.json | 9 +- .../bo4e_schemas/com/Steuerbetrag.json | 16 +- .../com/Tarifberechnungsparameter.json | 22 +- .../bo4e_schemas/com/Tarifeinschraenkung.json | 10 +- .../bo4e_schemas/com/Tarifpreis.json | 15 +- .../bo4e_schemas/com/Tarifpreisposition.json | 11 +- .../com/TarifpreispositionProOrt.json | 9 +- .../com/TarifpreisstaffelProOrt.json | 26 +- .../bo4e_schemas/com/Unterschrift.json | 9 +- .../test_data/bo4e_schemas/com/Verbrauch.json | 16 +- .../bo4e_schemas/com/Vertragskonditionen.json | 15 +- .../bo4e_schemas/com/Vertragsteil.json | 12 +- .../com/VerwendungszweckProMarktrolle.json | 8 +- .../test_data/bo4e_schemas/com/Zaehlwerk.json | 21 +- .../bo4e_schemas/com/Zaehlzeitregister.json | 9 +- .../test_data/bo4e_schemas/com/Zeitraum.json | 9 +- .../bo4e_schemas/com/Zeitreihenwert.json | 13 +- .../bo4e_schemas/com/Zeitspanne.json | 8 +- .../bo4e_schemas/com/Zustaendigkeit.json | 13 +- .../bo4e_schemas/enum/EMobilitaetsart.json | 10 + .../bo4e_schemas/enum/Kontaktart.json | 6 +- .../bo4e_schemas/enum/Lokationstyp.json | 5 +- .../bo4e_schemas/enum/Marktrolle.json | 21 +- .../bo4e_schemas/enum/Mengeneinheit.json | 5 +- .../bo4e_schemas/enum/Organisationstyp.json | 11 + .../bo4e_schemas/enum/Rufnummernart.json | 16 -- .../bo4e_schemas/enum/Speicherart.json | 11 + .../SteuerkanalLeistungsbeschreibung.json | 9 + .../enum/TechnischeRessourceNutzung.json | 10 + .../TechnischeRessourceVerbrauchsart.json | 11 + .../bo4e_schemas/enum/Themengebiet.json | 4 +- .../test_data/bo4e_schemas/enum/Typ.json | 8 +- unittests/test_main.py | 2 +- unittests/test_parser.py | 2 +- unittests/test_schema.py | 2 +- 116 files changed, 2426 insertions(+), 701 deletions(-) create mode 100644 src/bo4e_generator/imports.py delete mode 100644 unittests/test_data/bo4e_schemas/bo/Geschaeftsobjekt.json create mode 100644 unittests/test_data/bo4e_schemas/bo/Lokationszuordnung.json create mode 100644 unittests/test_data/bo4e_schemas/bo/Netzlokation.json rename unittests/test_data/bo4e_schemas/bo/{Ansprechpartner.json => Person.json} (60%) create mode 100644 unittests/test_data/bo4e_schemas/bo/SteuerbareRessource.json create mode 100644 unittests/test_data/bo4e_schemas/bo/TechnischeRessource.json delete mode 100644 unittests/test_data/bo4e_schemas/com/COM.json rename unittests/test_data/bo4e_schemas/com/{Messlokationszuordnung.json => Konfigurationsprodukt.json} (53%) create mode 100644 unittests/test_data/bo4e_schemas/com/Kontaktweg.json delete mode 100644 unittests/test_data/bo4e_schemas/com/Rufnummer.json create mode 100644 unittests/test_data/bo4e_schemas/enum/EMobilitaetsart.json create mode 100644 unittests/test_data/bo4e_schemas/enum/Organisationstyp.json delete mode 100644 unittests/test_data/bo4e_schemas/enum/Rufnummernart.json create mode 100644 unittests/test_data/bo4e_schemas/enum/Speicherart.json create mode 100644 unittests/test_data/bo4e_schemas/enum/SteuerkanalLeistungsbeschreibung.json create mode 100644 unittests/test_data/bo4e_schemas/enum/TechnischeRessourceNutzung.json create mode 100644 unittests/test_data/bo4e_schemas/enum/TechnischeRessourceVerbrauchsart.json diff --git a/src/bo4e_generator/__main__.py b/src/bo4e_generator/__main__.py index 820f384..1637322 100644 --- a/src/bo4e_generator/__main__.py +++ b/src/bo4e_generator/__main__.py @@ -8,9 +8,14 @@ import click -from bo4e_generator.parser import OutputType, bo4e_init_file_content, bo4e_version_file_content, parse_bo4e_schemas +from bo4e_generator.parser import ( + OutputType, + bo4e_init_file_content, + bo4e_version_file_content, + get_formatter, + parse_bo4e_schemas, +) from bo4e_generator.schema import get_namespace, get_version -from bo4e_generator.sqlparser import format_code def resolve_paths(input_directory: Path, output_directory: Path) -> tuple[Path, Path]: @@ -43,10 +48,11 @@ def generate_bo4e_schemas( if clear_output and output_directory.exists(): shutil.rmtree(output_directory) + formatter = get_formatter() for relative_file_path, file_content in file_contents.items(): file_path = output_directory / relative_file_path file_path.parent.mkdir(parents=True, exist_ok=True) - file_content = format_code(file_content) + file_content = formatter.format_code(file_content) file_path.write_text(file_content, encoding="utf-8") print(f"Created {file_path}") print("Done.") diff --git a/src/bo4e_generator/imports.py b/src/bo4e_generator/imports.py new file mode 100644 index 0000000..6cc5ce1 --- /dev/null +++ b/src/bo4e_generator/imports.py @@ -0,0 +1,129 @@ +""" +Contains monkey patches related to imports +""" + +import inspect +from collections import defaultdict +from typing import Iterable, List, Optional, Set, Union + +from datamodel_code_generator.imports import Import +from datamodel_code_generator.imports import Imports as _Imports + +from bo4e_generator.schema import SchemaMetadata + + +# pylint: disable=too-many-statements +def monkey_patch_imports(namespace: dict[str, SchemaMetadata]): + """ + Overwrites the behaviour how imports are rendered. They are not going through jinja templates. + They Imports class has a __str__ method, which we will overwrite here. + """ + namespace = {k: v for k, v in namespace.items() if k not in ("Typ", "Landescode")} + # "Typ" and "Landescode" must not be wrapped inside the "if TYPE_CHECKING" block because they are used explicitly + # to set default values. + import_type_checking = Import.from_full_path("typing.TYPE_CHECKING") + + # pylint: disable=missing-function-docstring + class Imports(_Imports): + """ + Re-implement some methods to customize the import rendering + """ + + def __str__(self) -> str: + return self.dump() + + def _set_alias(self, from_: Optional[str], imports: Set[str]) -> List[str]: + return [ + f"{i} as {self.alias[from_][i]}" if i in self.alias[from_] and i != self.alias[from_][i] else i + for i in sorted(imports) + ] + + def create_line(self, from_: Optional[str], imports: Set[str]) -> str: + if from_: + return f"from {from_} import {', '.join(self._set_alias(from_, imports))}" + return "\n".join(f"import {i}" for i in self._set_alias(from_, imports)) + + def dump(self) -> str: + imports_type_checking = defaultdict(set) + imports_no_type_checking = defaultdict(set) + for from_, imports in self.items(): + for import_ in imports: + if import_ in namespace: + imports_type_checking[from_].add(import_) + else: + imports_no_type_checking[from_].add(import_) + imports_dump = "\n".join( + self.create_line(from_, imports) for from_, imports in imports_no_type_checking.items() + ) + if len(imports_type_checking) > 0: + imports_dump += "\n\n" + imports_dump += "if TYPE_CHECKING:\n " + imports_dump += "\n ".join( + self.create_line(from_, imports) for from_, imports in imports_type_checking.items() + ) + return imports_dump + + def append(self, imports: Union[Import, Iterable[Import], None]) -> None: + if imports: + if isinstance(imports, Import): + imports = [imports] + for import_ in imports: + if import_.reference_path: + self.reference_paths[import_.reference_path] = import_ + if ( + import_type_checking.from_ not in self + or import_type_checking.import_ not in self[import_type_checking.from_] + ): + self.append(import_type_checking) + if "." in import_.import_: + self[None].add(import_.import_) + self.counter[(None, import_.import_)] += 1 + else: + self[import_.from_].add(import_.import_) + self.counter[(import_.from_, import_.import_)] += 1 + if import_.alias: + self.alias[import_.from_][import_.import_] = import_.alias + + def remove( + self, imports: Union[Import, Iterable[Import]], __intended_type_checking_remove: bool = False + ) -> None: + if isinstance(imports, Import): # pragma: no cover + imports = [imports] + for import_ in imports: + if not __intended_type_checking_remove and import_ == import_type_checking: + continue + if "." in import_.import_: # pragma: no cover + self.counter[(None, import_.import_)] -= 1 + if self.counter[(None, import_.import_)] == 0: # pragma: no cover + self[None].remove(import_.import_) + if not self[None]: + del self[None] + else: + self.counter[(import_.from_, import_.import_)] -= 1 # pragma: no cover + if self.counter[(import_.from_, import_.import_)] == 0: # pragma: no cover + self[import_.from_].remove(import_.import_) + if not self[import_.from_]: + del self[import_.from_] + if import_.alias: # pragma: no cover + del self.alias[import_.from_][import_.import_] + if not self.alias[import_.from_]: + del self.alias[import_.from_] + + if ( + import_type_checking.from_ in self + and import_type_checking.import_ in self[import_type_checking.from_] + and not any( + imp_str in namespace for imp_str_sets in self.values() for imp_str in imp_str_sets + ) + ): + self.remove( + import_type_checking, + __intended_type_checking_remove=True, # type: ignore[call-arg] + ) + + def remove_referenced_imports(self, reference_path: str) -> None: + if reference_path in self.reference_paths: + self.remove(self.reference_paths[reference_path]) + + for name, func in inspect.getmembers(Imports, inspect.isfunction): + setattr(_Imports, name, func) diff --git a/src/bo4e_generator/parser.py b/src/bo4e_generator/parser.py index 04d2f5b..71f910c 100644 --- a/src/bo4e_generator/parser.py +++ b/src/bo4e_generator/parser.py @@ -13,12 +13,14 @@ import datamodel_code_generator.parser.base import datamodel_code_generator.reference from datamodel_code_generator import DataModelType, PythonVersion +from datamodel_code_generator.format import CodeFormatter from datamodel_code_generator.imports import IMPORT_DATETIME from datamodel_code_generator.model import DataModelSet, get_data_model_types from datamodel_code_generator.model.enum import Enum as _Enum from datamodel_code_generator.parser.jsonschema import JsonSchemaParser from datamodel_code_generator.types import DataType, StrictTypes, Types +from bo4e_generator.imports import monkey_patch_imports from bo4e_generator.schema import SchemaMetadata from bo4e_generator.sqlparser import adapt_parse_for_sql, remove_pydantic_field_import, write_many_many_links @@ -75,6 +77,26 @@ class BO4EDataTypeManager(data_model_types.data_type_manager): # type: ignore[n featured in pydantic v2. Instead, the standard datetime type will be used. """ + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + class DataTypeWithForwardRef(self.data_type): + """ + Override the data type to replace explicit type references with forward references if the type + is present in namespace. + Also, the AwareDateTime import is replaced with the standard datetime import. + """ + + @property + def type_hint(self) -> str: + """Return the type hint for the data type.""" + type_ = super().type_hint + if self.reference and type_ in namespace: + type_ = f'"{type_}"' + return type_ + + self.data_type = DataTypeWithForwardRef + def type_map_factory( self, data_type: Type[DataType], @@ -86,6 +108,8 @@ def type_map_factory( result[Types.date_time] = data_type.from_import(IMPORT_DATETIME) return result + monkey_patch_imports(namespace) + return DataModelSet( data_model=BO4EDataModel, root_model=data_model_types.root_model, @@ -172,6 +196,16 @@ def bo4e_init_file_content(namespace: dict[str, SchemaMetadata], version: str) - init_file_content += f"from .{'.'.join(schema_metadata.module_path)} import {schema_metadata.class_name}\n" init_file_content += "\nfrom .__version__ import __version__\n" + init_file_content += ( + "from pydantic import BaseModel as _PydanticBaseModel\n" + "\n\n# Resolve all ForwardReferences. This design prevents circular import errors.\n" + "for cls_name in __all__:\n" + " cls = globals().get(cls_name, None)\n" + " if cls is None or not isinstance(cls, type) or not issubclass(cls, _PydanticBaseModel):\n" + " continue\n" + " cls.model_rebuild(force=True)\n" + ) + return init_file_content @@ -182,6 +216,13 @@ def remove_future_import(python_code: str) -> str: return re.sub(r"from __future__ import annotations\n\n", "", python_code) +def remove_model_rebuild(python_code: str, class_name: str) -> str: + """ + Remove the model_rebuild call from the generated code. + """ + return re.sub(rf"{class_name}\.model_rebuild\(\)\n", "", python_code) + + def parse_bo4e_schemas( input_directory: Path, namespace: dict[str, SchemaMetadata], output_type: OutputType ) -> dict[Path, str]: @@ -218,7 +259,7 @@ def parse_bo4e_schemas( use_schema_description=True, use_subclass_enum=True, use_standard_collections=True, - use_union_operator=True, + use_union_operator=False, use_field_description=True, set_default_enum_member=True, snake_case_field=True, @@ -251,6 +292,7 @@ def parse_bo4e_schemas( ) python_code = remove_future_import(parse_result.pop(module_path).body) + python_code = remove_model_rebuild(python_code, schema_metadata.class_name) if output_type is OutputType.SQL_MODEL.name: # remove pydantic field python_code = remove_pydantic_field_import(python_code) @@ -266,3 +308,18 @@ def parse_bo4e_schemas( file_contents[Path("many.py")] = write_many_many_links(links) return file_contents + + +def get_formatter() -> CodeFormatter: + """ + Returns a formatter to apply black and isort + """ + return CodeFormatter( + PythonVersion.PY_311, + None, + None, + skip_string_normalization=False, + known_third_party=None, + custom_formatters=None, + custom_formatters_kwargs=None, + ) diff --git a/unittests/test_data/bo4e_schemas/ZusatzAttribut.json b/unittests/test_data/bo4e_schemas/ZusatzAttribut.json index 68041ca..87b8dc1 100644 --- a/unittests/test_data/bo4e_schemas/ZusatzAttribut.json +++ b/unittests/test_data/bo4e_schemas/ZusatzAttribut.json @@ -1,8 +1,9 @@ { - "description": "Viele Datenobjekte weisen in unterschiedlichen Systemen eine eindeutige ID (Kundennummer, GP-Nummer etc.) auf.\nBeim Austausch von Datenobjekten zwischen verschiedenen Systemen ist es daher hilfreich,\nsich die eindeutigen IDs der anzubindenden Systeme zu merken.\n\n.. raw:: html\n\n \n\n.. HINT::\n `ZusatzAttribut JSON Schema `_", + "description": "Viele Datenobjekte weisen in unterschiedlichen Systemen eine eindeutige ID (Kundennummer, GP-Nummer etc.) auf.\nBeim Austausch von Datenobjekten zwischen verschiedenen Systemen ist es daher hilfreich,\nsich die eindeutigen IDs der anzubindenden Systeme zu merken.\n\n.. raw:: html\n\n \n\n.. HINT::\n `ZusatzAttribut JSON Schema `_", "title": "ZusatzAttribut", "properties": { "name": { + "description": "Bezeichnung der externen Referenz (z.B. \"microservice xyz\" oder \"SAP CRM GP-Nummer\")", "title": "Name", "anyOf": [ { @@ -14,6 +15,7 @@ ] }, "wert": { + "description": "Bezeichnung der externen Referenz (z.B. \"microservice xyz\" oder \"SAP CRM GP-Nummer\")", "title": "Wert" } }, diff --git a/unittests/test_data/bo4e_schemas/bo/Angebot.json b/unittests/test_data/bo4e_schemas/bo/Angebot.json index 652f70e..6e6b016 100644 --- a/unittests/test_data/bo4e_schemas/bo/Angebot.json +++ b/unittests/test_data/bo4e_schemas/bo/Angebot.json @@ -1,9 +1,10 @@ { - "description": "Mit diesem BO kann ein Versorgungsangebot zur Strom- oder Gasversorgung oder die Teilnahme an einer Ausschreibung\nübertragen werden. Es können verschiedene Varianten enthalten sein (z.B. ein- und mehrjährige Laufzeit).\nInnerhalb jeder Variante können Teile enthalten sein, die jeweils für eine oder mehrere Marktlokationen erstellt\nwerden.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Angebot JSON Schema `_", + "description": "Mit diesem BO kann ein Versorgungsangebot zur Strom- oder Gasversorgung oder die Teilnahme an einer Ausschreibung\nübertragen werden. Es können verschiedene Varianten enthalten sein (z.B. ein- und mehrjährige Laufzeit).\nInnerhalb jeder Variante können Teile enthalten sein, die jeweils für eine oder mehrere Marktlokationen erstellt\nwerden.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Angebot JSON Schema `_", "title": "Angebot", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Eindeutige Nummer des Angebotes", "default": "ANGEBOT", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "anfragereferenz": { + "description": "Bis zu diesem Zeitpunkt (Tag/Uhrzeit) inklusive gilt das Angebot", "title": "Anfragereferenz", "default": null, "anyOf": [ @@ -51,6 +55,7 @@ ] }, "angebotsdatum": { + "description": "Erstellungsdatum des Angebots", "title": "Angebotsdatum", "default": null, "anyOf": [ @@ -64,6 +69,7 @@ ] }, "angebotsgeber": { + "description": "Ersteller des Angebots", "default": null, "anyOf": [ { @@ -75,6 +81,7 @@ ] }, "angebotsnehmer": { + "description": "Empfänger des Angebots", "default": null, "anyOf": [ { @@ -86,6 +93,7 @@ ] }, "angebotsnummer": { + "description": "Eindeutige Nummer des Angebotes", "title": "Angebotsnummer", "default": null, "anyOf": [ @@ -98,6 +106,7 @@ ] }, "bindefrist": { + "description": "Bis zu diesem Zeitpunkt (Tag/Uhrzeit) inklusive gilt das Angebot", "title": "Bindefrist", "default": null, "anyOf": [ @@ -111,6 +120,7 @@ ] }, "sparte": { + "description": "Sparte, für die das Angebot abgegeben wird (Strom/Gas)", "default": null, "anyOf": [ { @@ -122,10 +132,11 @@ ] }, "unterzeichnerAngebotsgeber": { + "description": "Person, die als Angebotsgeber das Angebots ausgestellt hat", "default": null, "anyOf": [ { - "$ref": "Ansprechpartner.json#" + "$ref": "Person.json#" }, { "type": "null" @@ -133,10 +144,11 @@ ] }, "unterzeichnerAngebotsnehmer": { + "description": "Person, die als Angebotsnehmer das Angebot angenommen hat", "default": null, "anyOf": [ { - "$ref": "Ansprechpartner.json#" + "$ref": "Person.json#" }, { "type": "null" diff --git a/unittests/test_data/bo4e_schemas/bo/Ausschreibung.json b/unittests/test_data/bo4e_schemas/bo/Ausschreibung.json index 75a0f85..534d97e 100644 --- a/unittests/test_data/bo4e_schemas/bo/Ausschreibung.json +++ b/unittests/test_data/bo4e_schemas/bo/Ausschreibung.json @@ -1,9 +1,10 @@ { - "description": "Das BO Ausschreibung dient zur detaillierten Darstellung von ausgeschriebenen Energiemengen in der Energiewirtschaft\n\n.. raw:: html\n\n \n\n.. HINT::\n `Ausschreibung JSON Schema `_", + "description": "Das BO Ausschreibung dient zur detaillierten Darstellung von ausgeschriebenen Energiemengen in der Energiewirtschaft\n\n.. raw:: html\n\n \n\n.. HINT::\n `Ausschreibung JSON Schema `_", "title": "Ausschreibung", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Vom Herausgeber der Ausschreibung vergebene eindeutige Nummer", "default": "AUSSCHREIBUNG", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -61,6 +64,7 @@ ] }, "ausschreibungportal": { + "description": "Aufzählung der unterstützten Ausschreibungsportale", "default": null, "anyOf": [ { @@ -72,6 +76,7 @@ ] }, "ausschreibungsnummer": { + "description": "Vom Herausgeber der Ausschreibung vergebene eindeutige Nummer", "title": "Ausschreibungsnummer", "default": null, "anyOf": [ @@ -84,6 +89,7 @@ ] }, "ausschreibungsstatus": { + "description": "Bezeichnungen für die Ausschreibungsphasen", "default": null, "anyOf": [ { @@ -95,6 +101,7 @@ ] }, "ausschreibungstyp": { + "description": "Aufzählung für die Typisierung von Ausschreibungen", "default": null, "anyOf": [ { @@ -106,6 +113,7 @@ ] }, "bindefrist": { + "description": "Die einzelnen Lose, aus denen sich die Ausschreibung zusammensetzt", "default": null, "anyOf": [ { @@ -117,6 +125,7 @@ ] }, "istKostenpflichtig": { + "description": "Kennzeichen, ob die Ausschreibung kostenpflichtig ist", "title": "Istkostenpflichtig", "default": null, "anyOf": [ @@ -129,6 +138,7 @@ ] }, "lose": { + "description": "Die einzelnen Lose, aus denen sich die Ausschreibung zusammensetzt", "title": "Lose", "default": null, "anyOf": [ @@ -144,6 +154,7 @@ ] }, "veroeffentlichungszeitpunkt": { + "description": "Gibt den Veröffentlichungszeitpunkt der Ausschreibung an", "title": "Veroeffentlichungszeitpunkt", "default": null, "anyOf": [ @@ -157,6 +168,7 @@ ] }, "webseite": { + "description": "Internetseite, auf der die Ausschreibung veröffentlicht wurde (falls vorhanden)", "title": "Webseite", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/bo/Buendelvertrag.json b/unittests/test_data/bo4e_schemas/bo/Buendelvertrag.json index e27ecd0..102c03d 100644 --- a/unittests/test_data/bo4e_schemas/bo/Buendelvertrag.json +++ b/unittests/test_data/bo4e_schemas/bo/Buendelvertrag.json @@ -1,9 +1,10 @@ { - "description": "Abbildung eines Bündelvertrags.\nEs handelt sich hierbei um eine Liste von Einzelverträgen, die in einem Vertragsobjekt gebündelt sind.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Buendelvertrag JSON Schema `_", + "description": "Abbildung eines Bündelvertrags.\nEs handelt sich hierbei um eine Liste von Einzelverträgen, die in einem Vertragsobjekt gebündelt sind.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Buendelvertrag JSON Schema `_", "title": "Buendelvertrag", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Der Typ des Geschäftsobjektes", "default": "BUENDELVERTRAG", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "beschreibung": { + "description": "Beschreibung zum Vertrag", "title": "Beschreibung", "default": null, "anyOf": [ @@ -51,6 +55,7 @@ ] }, "einzelvertraege": { + "description": "Die Liste mit den Einzelverträgen zu den Abnahmestellen", "title": "Einzelvertraege", "default": null, "anyOf": [ @@ -66,6 +71,7 @@ ] }, "sparte": { + "description": "Unterscheidungsmöglichkeiten für die Sparte", "default": null, "anyOf": [ { @@ -77,6 +83,7 @@ ] }, "unterzeichnervp1": { + "description": "Unterzeichner des Vertragspartners1", "title": "Unterzeichnervp1", "default": null, "anyOf": [ @@ -92,6 +99,7 @@ ] }, "unterzeichnervp2": { + "description": "Unterzeichner des Vertragspartners2", "title": "Unterzeichnervp2", "default": null, "anyOf": [ @@ -107,6 +115,7 @@ ] }, "vertragsart": { + "description": "Hier ist festgelegt, um welche Art von Vertrag es sich handelt. Z.B. Netznutzungvertrag", "default": null, "anyOf": [ { @@ -118,6 +127,7 @@ ] }, "vertragsbeginn": { + "description": "Gibt an, wann der Vertrag beginnt (inklusiv)", "title": "Vertragsbeginn", "default": null, "anyOf": [ @@ -131,6 +141,7 @@ ] }, "vertragsende": { + "description": "Gibt an, wann der Vertrag (voraussichtlich) endet oder beendet wurde (exklusiv)", "title": "Vertragsende", "default": null, "anyOf": [ @@ -144,6 +155,7 @@ ] }, "vertragskonditionen": { + "description": "Festlegungen zu Laufzeiten und Kündigungsfristen", "title": "Vertragskonditionen", "default": null, "anyOf": [ @@ -159,6 +171,7 @@ ] }, "vertragsnummer": { + "description": "Eine im Verwendungskontext eindeutige Nummer für den Vertrag", "title": "Vertragsnummer", "default": null, "anyOf": [ @@ -171,6 +184,7 @@ ] }, "vertragspartner1": { + "description": "Beispiel: \"Vertrag zwischen Vertagspartner 1 ...\"", "default": null, "anyOf": [ { @@ -182,6 +196,7 @@ ] }, "vertragspartner2": { + "description": "Beispiel \"Vertrag zwischen Vertagspartner 1 und Vertragspartner 2\"", "default": null, "anyOf": [ { @@ -193,6 +208,7 @@ ] }, "vertragsstatus": { + "description": "Gibt den Status des Vertrages an", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/bo/Energiemenge.json b/unittests/test_data/bo4e_schemas/bo/Energiemenge.json index 60be2b0..a78fb53 100644 --- a/unittests/test_data/bo4e_schemas/bo/Energiemenge.json +++ b/unittests/test_data/bo4e_schemas/bo/Energiemenge.json @@ -1,9 +1,10 @@ { - "description": "Abbildung von Mengen, die Lokationen zugeordnet sind\n\n.. raw:: html\n\n \n\n.. HINT::\n `Energiemenge JSON Schema `_", + "description": "Abbildung von Mengen, die Lokationen zugeordnet sind\n\n.. raw:: html\n\n \n\n.. HINT::\n `Energiemenge JSON Schema `_", "title": "Energiemenge", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Eindeutige Nummer der Marktlokation bzw. der Messlokation, zu der die Energiemenge gehört", "default": "ENERGIEMENGE", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "energieverbrauch": { + "description": "Gibt den Verbrauch in einer Zeiteinheit an", "title": "Energieverbrauch", "default": null, "anyOf": [ @@ -54,6 +58,7 @@ ] }, "lokationsId": { + "description": "Eindeutige Nummer der Marktlokation bzw. der Messlokation, zu der die Energiemenge gehört", "title": "Lokationsid", "default": null, "anyOf": [ @@ -66,6 +71,7 @@ ] }, "lokationstyp": { + "description": "Gibt an, ob es sich um eine Markt- oder Messlokation handelt", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/bo/Fremdkosten.json b/unittests/test_data/bo4e_schemas/bo/Fremdkosten.json index 990de91..dbac43b 100644 --- a/unittests/test_data/bo4e_schemas/bo/Fremdkosten.json +++ b/unittests/test_data/bo4e_schemas/bo/Fremdkosten.json @@ -1,9 +1,10 @@ { - "description": "Mit diesem BO werden die Fremdkosten, beispielsweise für eine Angebotserstellung oder eine Rechnungsprüfung,\nübertragen.\nDie Fremdkosten enthalten dabei alle Kostenblöcke, die von anderen Marktteilnehmern oder Instanzen erhoben werden.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Fremdkosten JSON Schema `_", + "description": "Mit diesem BO werden die Fremdkosten, beispielsweise für eine Angebotserstellung oder eine Rechnungsprüfung,\nübertragen.\nDie Fremdkosten enthalten dabei alle Kostenblöcke, die von anderen Marktteilnehmern oder Instanzen erhoben werden.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Fremdkosten JSON Schema `_", "title": "Fremdkosten", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Für diesen Zeitraum wurden die Kosten ermittelt", "default": "FREMDKOSTEN", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "gueltigkeit": { + "description": "Für diesen Zeitraum wurden die Kosten ermittelt", "default": null, "anyOf": [ { @@ -50,6 +54,7 @@ ] }, "kostenbloecke": { + "description": "In Kostenblöcken werden Kostenpositionen zusammengefasst. Beispiele: Netzkosten, Umlagen, Steuern etc", "title": "Kostenbloecke", "default": null, "anyOf": [ @@ -65,6 +70,7 @@ ] }, "summeKosten": { + "description": "Die Gesamtsumme über alle Kostenblöcke und -positionen", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/bo/Geraet.json b/unittests/test_data/bo4e_schemas/bo/Geraet.json index 30f37dd..f2a234d 100644 --- a/unittests/test_data/bo4e_schemas/bo/Geraet.json +++ b/unittests/test_data/bo4e_schemas/bo/Geraet.json @@ -1,9 +1,10 @@ { - "description": "Mit diesem BO werden alle Geräte modelliert, die keine Zähler sind.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Geraet JSON Schema `_", + "description": "Mit diesem BO werden alle Geräte modelliert, die keine Zähler sind.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Geraet JSON Schema `_", "title": "Geraet", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Die auf dem Gerät aufgedruckte Nummer, die vom MSB vergeben wird.", "default": "GERAET", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "bezeichnung": { + "description": "Bezeichnung des Geräts", "title": "Bezeichnung", "default": null, "anyOf": [ @@ -51,6 +55,7 @@ ] }, "geraeteklasse": { + "description": "Die übergreifende Klasse eines Geräts, beispielsweise Wandler", "default": null, "anyOf": [ { @@ -62,6 +67,7 @@ ] }, "geraetenummer": { + "description": "Die auf dem Gerät aufgedruckte Nummer, die vom MSB vergeben wird.", "title": "Geraetenummer", "default": null, "anyOf": [ @@ -74,6 +80,7 @@ ] }, "geraetetyp": { + "description": "Der speziellere Typ eines Gerätes, beispielsweise Stromwandler", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/bo/Geschaeftsobjekt.json b/unittests/test_data/bo4e_schemas/bo/Geschaeftsobjekt.json deleted file mode 100644 index 98596ed..0000000 --- a/unittests/test_data/bo4e_schemas/bo/Geschaeftsobjekt.json +++ /dev/null @@ -1,58 +0,0 @@ -{ - "description": "Das BO Geschäftsobjekt ist der Master für alle Geschäftsobjekte.\nAlle Attribute, die hier in diesem BO enthalten sind, werden an alle BOs vererbt.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Geschaeftsobjekt JSON Schema `_", - "title": "Geschaeftsobjekt", - "additionalProperties": true, - "properties": { - "_id": { - "title": " Id", - "default": null, - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "_typ": { - "default": "GESCHAEFTSOBJEKT", - "anyOf": [ - { - "$ref": "../enum/Typ.json#" - }, - { - "type": "null" - } - ] - }, - "_version": { - "title": " Version", - "default": "v202401.0.1", - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "zusatzAttribute": { - "title": "Zusatzattribute", - "default": null, - "anyOf": [ - { - "items": { - "$ref": "../ZusatzAttribut.json#" - }, - "type": "array" - }, - { - "type": "null" - } - ] - } - }, - "type": "object" -} diff --git a/unittests/test_data/bo4e_schemas/bo/Geschaeftspartner.json b/unittests/test_data/bo4e_schemas/bo/Geschaeftspartner.json index b90c47d..b80560a 100644 --- a/unittests/test_data/bo4e_schemas/bo/Geschaeftspartner.json +++ b/unittests/test_data/bo4e_schemas/bo/Geschaeftspartner.json @@ -1,9 +1,10 @@ { - "description": "Mit diesem Objekt können Geschäftspartner übertragen werden.\nSowohl Unternehmen, als auch Privatpersonen können Geschäftspartner sein.\nHinweis: Marktteilnehmer haben ein eigenes BO, welches sich von diesem BO ableitet.\nHier sollte daher keine Zuordnung zu Marktrollen erfolgen.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Geschaeftspartner JSON Schema `_", + "description": "Mit diesem Objekt können Geschäftspartner übertragen werden.\nSowohl Unternehmen, als auch Privatpersonen können Geschäftspartner sein.\nHinweis: \"Marktteilnehmer\" haben ein eigenes BO, welches sich von diesem BO ableitet.\nHier sollte daher keine Zuordnung zu Marktrollen erfolgen.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Geschaeftspartner JSON Schema `_", "title": "Geschaeftspartner", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Mögliche Anrede der Person", "default": "GESCHAEFTSPARTNER", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -38,7 +41,20 @@ } ] }, + "adresse": { + "description": "Adresse des Geschäftspartners", + "default": null, + "anyOf": [ + { + "$ref": "../com/Adresse.json#" + }, + { + "type": "null" + } + ] + }, "amtsgericht": { + "description": "Amtsgericht bzw Handelsregistergericht, das die Handelsregisternummer herausgegeben hat", "title": "Amtsgericht", "default": null, "anyOf": [ @@ -51,6 +67,7 @@ ] }, "anrede": { + "description": "Mögliche Anrede der Person", "default": null, "anyOf": [ { @@ -61,20 +78,24 @@ } ] }, - "eMailAdresse": { - "title": "Emailadresse", + "ansprechpartner": { + "title": "Ansprechpartner", "default": null, "anyOf": [ { - "type": "string" + "items": { + "$ref": "Person.json#" + }, + "type": "array" }, { "type": "null" } ] }, - "geschaeftspartnerrolle": { - "title": "Geschaeftspartnerrolle", + "geschaeftspartnerrollen": { + "description": "Rollen, die die Geschäftspartner inne haben (z.B. Interessent, Kunde)", + "title": "Geschaeftspartnerrollen", "default": null, "anyOf": [ { @@ -89,6 +110,7 @@ ] }, "glaeubigerId": { + "description": "Die Gläubiger-ID welche im Zahlungsverkehr verwendet wird; Z.B. \"DE 47116789\"", "title": "Glaeubigerid", "default": null, "anyOf": [ @@ -100,8 +122,9 @@ } ] }, - "hrnummer": { - "title": "Hrnummer", + "handelsregisternummer": { + "description": "Handelsregisternummer des Geschäftspartners", + "title": "Handelsregisternummer", "default": null, "anyOf": [ { @@ -112,25 +135,26 @@ } ] }, - "istGewerbe": { - "title": "Istgewerbe", + "individuelleAnrede": { + "title": "Individuelleanrede", "default": null, "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ] }, - "kontaktweg": { - "title": "Kontaktweg", + "kontaktwege": { + "description": "Kontaktwege des Geschäftspartners", + "title": "Kontaktwege", "default": null, "anyOf": [ { "items": { - "$ref": "../enum/Kontaktart.json#" + "$ref": "../com/Kontaktweg.json#" }, "type": "array" }, @@ -139,8 +163,9 @@ } ] }, - "name1": { - "title": "Name1", + "nachname": { + "description": "Nachname (Familienname) der Person", + "title": "Nachname", "default": null, "anyOf": [ { @@ -151,8 +176,9 @@ } ] }, - "name2": { - "title": "Name2", + "organisationsname": { + "description": "Kontaktwege des Geschäftspartners", + "title": "Organisationsname", "default": null, "anyOf": [ { @@ -163,23 +189,23 @@ } ] }, - "name3": { - "title": "Name3", + "organisationstyp": { "default": null, "anyOf": [ { - "type": "string" + "$ref": "../enum/Organisationstyp.json#" }, { "type": "null" } ] }, - "partneradresse": { + "titel": { + "description": "Möglicher Titel der Person", "default": null, "anyOf": [ { - "$ref": "../com/Adresse.json#" + "$ref": "../enum/Titel.json#" }, { "type": "null" @@ -187,6 +213,7 @@ ] }, "umsatzsteuerId": { + "description": "Die Steuer-ID des Geschäftspartners; Beispiel: \"DE 813281825\"", "title": "Umsatzsteuerid", "default": null, "anyOf": [ @@ -198,7 +225,21 @@ } ] }, + "vorname": { + "description": "Vorname der Person", + "title": "Vorname", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, "website": { + "description": "Internetseite des Marktpartners", "title": "Website", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/bo/Kosten.json b/unittests/test_data/bo4e_schemas/bo/Kosten.json index d65d1f7..c4fcba2 100644 --- a/unittests/test_data/bo4e_schemas/bo/Kosten.json +++ b/unittests/test_data/bo4e_schemas/bo/Kosten.json @@ -1,9 +1,10 @@ { - "description": "Dieses BO wird zur Übertagung von hierarchischen Kostenstrukturen verwendet.\nDie Kosten werden dabei in Kostenblöcke und diese wiederum in Kostenpositionen strukturiert.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Kosten JSON Schema `_", + "description": "Dieses BO wird zur Übertagung von hierarchischen Kostenstrukturen verwendet.\nDie Kosten werden dabei in Kostenblöcke und diese wiederum in Kostenpositionen strukturiert.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Kosten JSON Schema `_", "title": "Kosten", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Klasse der Kosten, beispielsweise Fremdkosten", "default": "KOSTEN", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "gueltigkeit": { + "description": "Für diesen Zeitraum wurden die Kosten ermittelt", "default": null, "anyOf": [ { @@ -50,6 +54,7 @@ ] }, "kostenbloecke": { + "description": "In Kostenblöcken werden Kostenpositionen zusammengefasst. Beispiele: Netzkosten, Umlagen, Steuern etc", "title": "Kostenbloecke", "default": null, "anyOf": [ @@ -65,6 +70,7 @@ ] }, "kostenklasse": { + "description": "Klasse der Kosten, beispielsweise Fremdkosten", "default": null, "anyOf": [ { @@ -76,6 +82,7 @@ ] }, "summeKosten": { + "description": "Die Gesamtsumme über alle Kostenblöcke und -positionen", "title": "Summekosten", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/bo/Lastgang.json b/unittests/test_data/bo4e_schemas/bo/Lastgang.json index 86fa060..674d03a 100644 --- a/unittests/test_data/bo4e_schemas/bo/Lastgang.json +++ b/unittests/test_data/bo4e_schemas/bo/Lastgang.json @@ -1,9 +1,10 @@ { - "description": "Modell zur Abbildung eines Lastganges;\nIn diesem Modell werden die Messwerte mit einem vollständigen Zeitintervall (zeit_intervall_laenge) angegeben und es bietet daher eine hohe Flexibilität in der Übertragung jeglicher zeitlich veränderlicher Messgrössen.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Lastgang JSON Schema `_", + "description": "Modell zur Abbildung eines Lastganges;\nIn diesem Modell werden die Messwerte mit einem vollständigen Zeitintervall (zeit_intervall_laenge) angegeben und es bietet daher eine hohe Flexibilität in der Übertragung jeglicher zeitlich veränderlicher Messgrössen.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Lastgang JSON Schema `_", "title": "Lastgang", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Angabe, ob es sich um einen Gas- oder Stromlastgang handelt", "default": "LASTGANG", "anyOf": [ { @@ -27,6 +29,7 @@ ] }, "marktlokation": { + "description": "Marktlokation, zu der der Lastgang gehört", "default": null, "anyOf": [ { @@ -38,6 +41,7 @@ ] }, "messgroesse": { + "description": "Definition der gemessenen Größe anhand ihrer Einheit", "default": null, "anyOf": [ { @@ -49,6 +53,7 @@ ] }, "messlokation": { + "description": "Marktlokation, zu der der Lastgang gehört", "default": null, "anyOf": [ { @@ -60,6 +65,7 @@ ] }, "obisKennzahl": { + "description": "Die OBIS-Kennzahl für den Wert, die festlegt, welche Größe mit dem Stand gemeldet wird, z.B. '1-0:1.8.1'", "title": "Obiskennzahl", "default": null, "anyOf": [ @@ -72,6 +78,7 @@ ] }, "sparte": { + "description": "Angabe, ob es sich um einen Gas- oder Stromlastgang handelt", "default": null, "anyOf": [ { @@ -83,6 +90,7 @@ ] }, "version": { + "description": "Versionsnummer des Lastgangs", "title": "Version", "default": null, "anyOf": [ @@ -95,6 +103,7 @@ ] }, "werte": { + "description": "Die im Lastgang enthaltenen Messwerte", "title": "Werte", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/bo/Lokationszuordnung.json b/unittests/test_data/bo4e_schemas/bo/Lokationszuordnung.json new file mode 100644 index 0000000..72375f6 --- /dev/null +++ b/unittests/test_data/bo4e_schemas/bo/Lokationszuordnung.json @@ -0,0 +1,179 @@ +{ + "description": "Modell für die Abbildung der Referenz auf die Lokationsbündelstruktur. Diese gibt an welche Marktlokationen,\nMesslokationen, Netzlokationen, technische/steuerbaren Ressourcen an einer Lokation vorhanden sind.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Lokationszuordnung JSON Schema `_", + "title": "Lokationszuordnung", + "additionalProperties": true, + "properties": { + "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", + "title": " Id", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "_typ": { + "description": "Liste mit referenzierten Marktlokationen", + "default": "LOKATIONSZUORDNUNG", + "anyOf": [ + { + "$ref": "../enum/Typ.json#" + }, + { + "type": "null" + } + ] + }, + "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", + "title": " Version", + "default": "v202401.3.2", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "gueltigkeit": { + "description": "Zeitspanne der Gültigkeit", + "default": null, + "anyOf": [ + { + "$ref": "../com/Zeitspanne.json#" + }, + { + "type": "null" + } + ] + }, + "lokationsbuendelcode": { + "description": "Code, der angibt wie die Lokationsbündelstruktur zusammengesetzt ist (zu finden unter \"Codeliste der Lokationsbündelstrukturen\" auf https://www.edi-energy.de/index.php?id=38)", + "title": "Lokationsbuendelcode", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "marktlokationen": { + "description": "Liste mit referenzierten Marktlokationen", + "title": "Marktlokationen", + "default": null, + "anyOf": [ + { + "items": { + "$ref": "Marktlokation.json#" + }, + "type": "array" + }, + { + "type": "null" + } + ] + }, + "messlokationen": { + "description": "Liste mit referenzierten Messlokationen", + "title": "Messlokationen", + "default": null, + "anyOf": [ + { + "items": { + "$ref": "Messlokation.json#" + }, + "type": "array" + }, + { + "type": "null" + } + ] + }, + "netzlokationen": { + "description": "Liste mit referenzierten Netzlokationen", + "title": "Netzlokationen", + "default": null, + "anyOf": [ + { + "items": { + "$ref": "Netzlokation.json#" + }, + "type": "array" + }, + { + "type": "null" + } + ] + }, + "steuerbareRessourcen": { + "description": "Liste mit referenzierten steuerbaren Ressourcen", + "title": "Steuerbareressourcen", + "default": null, + "anyOf": [ + { + "items": { + "$ref": "SteuerbareRessource.json#" + }, + "type": "array" + }, + { + "type": "null" + } + ] + }, + "technischeRessourcen": { + "description": "Liste mit referenzierten technischen Ressourcen", + "title": "Technischeressourcen", + "default": null, + "anyOf": [ + { + "items": { + "$ref": "TechnischeRessource.json#" + }, + "type": "array" + }, + { + "type": "null" + } + ] + }, + "zuordnungstyp": { + "description": "Verknüpfungsrichtung z.B. Malo-Melo [TODO: Eventuell anderer Datentyp]", + "title": "Zuordnungstyp", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "zusatzAttribute": { + "title": "Zusatzattribute", + "default": null, + "anyOf": [ + { + "items": { + "$ref": "../ZusatzAttribut.json#" + }, + "type": "array" + }, + { + "type": "null" + } + ] + } + }, + "type": "object" +} diff --git a/unittests/test_data/bo4e_schemas/bo/Marktlokation.json b/unittests/test_data/bo4e_schemas/bo/Marktlokation.json index c9f434a..914aae6 100644 --- a/unittests/test_data/bo4e_schemas/bo/Marktlokation.json +++ b/unittests/test_data/bo4e_schemas/bo/Marktlokation.json @@ -1,9 +1,10 @@ { - "description": "Object containing information about a Marktlokation\n\n.. raw:: html\n\n \n\n.. HINT::\n `Marktlokation JSON Schema `_", + "description": "Object containing information about a Marktlokation\n\n.. raw:: html\n\n \n\n.. HINT::\n `Marktlokation JSON Schema `_", "title": "Marktlokation", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Identifikationsnummer einer Marktlokation, an der Energie entweder verbraucht, oder erzeugt wird.", "default": "MARKTLOKATION", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "bilanzierungsgebiet": { + "description": "Bilanzierungsgebiet, dem das Netzgebiet zugeordnet ist - im Falle eines Strom Netzes", "title": "Bilanzierungsgebiet", "default": null, "anyOf": [ @@ -51,6 +55,7 @@ ] }, "bilanzierungsmethode": { + "description": "Die Bilanzierungsmethode, RLM oder SLP", "default": null, "anyOf": [ { @@ -62,6 +67,7 @@ ] }, "endkunde": { + "description": "Geschäftspartner, dem diese Marktlokation gehört", "default": null, "anyOf": [ { @@ -73,6 +79,7 @@ ] }, "energierichtung": { + "description": "Kennzeichnung, ob Energie eingespeist oder entnommen (ausgespeist) wird", "default": null, "anyOf": [ { @@ -84,6 +91,7 @@ ] }, "gasqualitaet": { + "description": "Die Gasqualität in diesem Netzgebiet. H-Gas oder L-Gas. Im Falle eines Gas-Netzes", "default": null, "anyOf": [ { @@ -95,6 +103,7 @@ ] }, "gebietstyp": { + "description": "Typ des Netzgebietes, z.B. Verteilnetz", "default": null, "anyOf": [ { @@ -117,6 +126,7 @@ ] }, "grundversorgercodenr": { + "description": "Codenummer des Grundversorgers, der für diese Marktlokation zuständig ist", "title": "Grundversorgercodenr", "default": null, "anyOf": [ @@ -129,6 +139,7 @@ ] }, "istUnterbrechbar": { + "description": "Gibt an, ob es sich um eine unterbrechbare Belieferung handelt", "title": "Istunterbrechbar", "default": null, "anyOf": [ @@ -152,6 +163,7 @@ ] }, "kundengruppen": { + "description": "Kundengruppen der Marktlokation", "title": "Kundengruppen", "default": null, "anyOf": [ @@ -167,6 +179,7 @@ ] }, "lokationsadresse": { + "description": "Die Adresse, an der die Energie-Lieferung oder -Einspeisung erfolgt", "default": null, "anyOf": [ { @@ -177,7 +190,50 @@ } ] }, + "lokationsbuendelObjektcode": { + "description": "Lokationsbuendel Code, der die Funktion dieses BOs an der Lokationsbuendelstruktur beschreibt.", + "title": "Lokationsbuendelobjektcode", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "lokationszuordnungen": { + "description": "Lokationszuordnung, um bspw. die zugehörigen Messlokationen anzugeben", + "title": "Lokationszuordnungen", + "default": null, + "anyOf": [ + { + "items": { + "$ref": "Lokationszuordnung.json#" + }, + "type": "array" + }, + { + "type": "null" + } + ] + }, + "marktgebiet": { + "description": "für Gas. Code vom EIC, https://www.entsog.eu/data/data-portal/codes-list", + "title": "Marktgebiet", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, "marktlokationsId": { + "description": "Identifikationsnummer einer Marktlokation, an der Energie entweder verbraucht, oder erzeugt wird.", "title": "Marktlokationsid", "default": null, "anyOf": [ @@ -190,6 +246,7 @@ ] }, "netzbetreibercodenr": { + "description": "Codenummer des Netzbetreibers, an dessen Netz diese Marktlokation angeschlossen ist.", "title": "Netzbetreibercodenr", "default": null, "anyOf": [ @@ -213,6 +270,7 @@ ] }, "netzgebietsnr": { + "description": "Die ID des Gebietes in der ene't-Datenbank", "title": "Netzgebietsnr", "default": null, "anyOf": [ @@ -224,7 +282,21 @@ } ] }, + "regelzone": { + "description": "Kundengruppen der Marktlokation", + "title": "Regelzone", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, "sparte": { + "description": "Sparte der Marktlokation, z.B. Gas oder Strom", "default": null, "anyOf": [ { @@ -236,6 +308,7 @@ ] }, "verbrauchsart": { + "description": "Verbrauchsart der Marktlokation.", "default": null, "anyOf": [ { @@ -246,11 +319,47 @@ } ] }, - "zugehoerigeMesslokation": { + "verbrauchsmengen": { + "title": "Verbrauchsmengen", + "default": null, + "anyOf": [ + { + "items": { + "$ref": "../com/Verbrauch.json#" + }, + "type": "array" + }, + { + "type": "null" + } + ] + }, + "zaehlwerke": { + "description": "für Gas. Code vom EIC, https://www.entsog.eu/data/data-portal/codes-list", + "title": "Zaehlwerke", "default": null, "anyOf": [ { - "$ref": "../com/Messlokationszuordnung.json#" + "items": { + "$ref": "../com/Zaehlwerk.json#" + }, + "type": "array" + }, + { + "type": "null" + } + ] + }, + "zaehlwerkeDerBeteiligtenMarktrolle": { + "description": "Lokationszuordnung, um bspw. die zugehörigen Messlokationen anzugeben", + "title": "Zaehlwerkederbeteiligtenmarktrolle", + "default": null, + "anyOf": [ + { + "items": { + "$ref": "../com/Zaehlwerk.json#" + }, + "type": "array" }, { "type": "null" diff --git a/unittests/test_data/bo4e_schemas/bo/Marktteilnehmer.json b/unittests/test_data/bo4e_schemas/bo/Marktteilnehmer.json index 8d9f24d..5ef0bd0 100644 --- a/unittests/test_data/bo4e_schemas/bo/Marktteilnehmer.json +++ b/unittests/test_data/bo4e_schemas/bo/Marktteilnehmer.json @@ -1,9 +1,10 @@ { - "description": "Objekt zur Aufnahme der Information zu einem Marktteilnehmer\n\n.. raw:: html\n\n \n\n.. HINT::\n `Marktteilnehmer JSON Schema `_", + "description": "Objekt zur Aufnahme der Information zu einem Marktteilnehmer\n\n.. raw:: html\n\n \n\n.. HINT::\n `Marktteilnehmer JSON Schema `_", "title": "Marktteilnehmer", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Gibt im Klartext die Bezeichnung der Marktrolle an", "default": "MARKTTEILNEHMER", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -38,99 +41,26 @@ } ] }, - "amtsgericht": { - "title": "Amtsgericht", + "geschaeftspartner": { + "description": "Der zu diesem Marktteilnehmer gehörende Geschäftspartner", "default": null, "anyOf": [ { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "anrede": { - "default": null, - "anyOf": [ - { - "$ref": "../enum/Anrede.json#" - }, - { - "type": "null" - } - ] - }, - "eMailAdresse": { - "title": "Emailadresse", - "default": null, - "anyOf": [ - { - "type": "string" + "$ref": "Geschaeftspartner.json#" }, { "type": "null" } ] }, - "geschaeftspartnerrolle": { - "title": "Geschaeftspartnerrolle", - "default": null, - "anyOf": [ - { - "items": { - "$ref": "../enum/Geschaeftspartnerrolle.json#" - }, - "type": "array" - }, - { - "type": "null" - } - ] - }, - "glaeubigerId": { - "title": "Glaeubigerid", - "default": null, - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "hrnummer": { - "title": "Hrnummer", - "default": null, - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "istGewerbe": { - "title": "Istgewerbe", - "default": null, - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ] - }, - "kontaktweg": { - "title": "Kontaktweg", + "makoadresse": { + "description": "Die 1:1-Kommunikationsadresse des Marktteilnehmers. Diese wird in der Marktkommunikation verwendet. Konkret kann dies eine eMail-Adresse oder ein AS4-Endpunkt sein.", + "title": "Makoadresse", "default": null, "anyOf": [ { "items": { - "$ref": "../enum/Kontaktart.json#" + "type": "string" }, "type": "array" }, @@ -139,19 +69,8 @@ } ] }, - "makoadresse": { - "title": "Makoadresse", - "default": null, - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, "marktrolle": { + "description": "Gibt im Klartext die Bezeichnung der Marktrolle an", "default": null, "anyOf": [ { @@ -162,54 +81,8 @@ } ] }, - "name1": { - "title": "Name1", - "default": null, - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "name2": { - "title": "Name2", - "default": null, - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "name3": { - "title": "Name3", - "default": null, - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "partneradresse": { - "default": null, - "anyOf": [ - { - "$ref": "../com/Adresse.json#" - }, - { - "type": "null" - } - ] - }, "rollencodenummer": { + "description": "Gibt die Codenummer der Marktrolle an", "title": "Rollencodenummer", "default": null, "anyOf": [ @@ -222,6 +95,7 @@ ] }, "rollencodetyp": { + "description": "Gibt den Typ des Codes an", "default": null, "anyOf": [ { @@ -233,6 +107,7 @@ ] }, "sparte": { + "description": "Sparte des Marktteilnehmers, z.B. Gas oder Strom", "default": null, "anyOf": [ { @@ -243,30 +118,6 @@ } ] }, - "umsatzsteuerId": { - "title": "Umsatzsteuerid", - "default": null, - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "website": { - "title": "Website", - "default": null, - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, "zusatzAttribute": { "title": "Zusatzattribute", "default": null, diff --git a/unittests/test_data/bo4e_schemas/bo/Messlokation.json b/unittests/test_data/bo4e_schemas/bo/Messlokation.json index a46113d..d40097f 100644 --- a/unittests/test_data/bo4e_schemas/bo/Messlokation.json +++ b/unittests/test_data/bo4e_schemas/bo/Messlokation.json @@ -1,9 +1,10 @@ { - "description": "Object containing information about a Messlokation\n\n.. raw:: html\n\n \n\n.. HINT::\n `Messlokation JSON Schema `_", + "description": "Object containing information about a Messlokation\n\n.. raw:: html\n\n \n\n.. HINT::\n `Messlokation JSON Schema `_", "title": "Messlokation", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Die Messlokations-Identifikation; Das ist die frühere Zählpunktbezeichnung", "default": "MESSLOKATION", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -50,6 +53,7 @@ ] }, "geraete": { + "description": "Liste der Geräte, die zu dieser Messstelle gehört", "title": "Geraete", "default": null, "anyOf": [ @@ -89,6 +93,7 @@ ] }, "katasterinformation": { + "description": "Lokationszuordnung, um bspw. die zugehörigen Marktlokationen anzugeben", "default": null, "anyOf": [ { @@ -99,6 +104,35 @@ } ] }, + "lokationsbuendelObjektcode": { + "description": "Lokationsbuendel Code, der die Funktion dieses BOs an der Lokationsbuendelstruktur beschreibt.", + "title": "Lokationsbuendelobjektcode", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "lokationszuordnungen": { + "description": "Lokationszuordnung, um bspw. die zugehörigen Marktlokationen anzugeben", + "title": "Lokationszuordnungen", + "default": null, + "anyOf": [ + { + "items": { + "$ref": "Lokationszuordnung.json#" + }, + "type": "array" + }, + { + "type": "null" + } + ] + }, "messadresse": { "default": null, "anyOf": [ @@ -111,6 +145,7 @@ ] }, "messdienstleistung": { + "description": "Liste der Messdienstleistungen, die zu dieser Messstelle gehört", "title": "Messdienstleistung", "default": null, "anyOf": [ @@ -126,6 +161,7 @@ ] }, "messgebietnr": { + "description": "Die Nummer des Messgebietes in der ene't-Datenbank", "title": "Messgebietnr", "default": null, "anyOf": [ @@ -138,6 +174,7 @@ ] }, "messlokationsId": { + "description": "Die Messlokations-Identifikation; Das ist die frühere Zählpunktbezeichnung", "title": "Messlokationsid", "default": null, "anyOf": [ @@ -150,6 +187,7 @@ ] }, "messlokationszaehler": { + "description": "Zähler, die zu dieser Messlokation gehören", "title": "Messlokationszaehler", "default": null, "anyOf": [ @@ -165,6 +203,7 @@ ] }, "netzebeneMessung": { + "description": "Spannungsebene der Messung", "default": null, "anyOf": [ { @@ -176,6 +215,7 @@ ] }, "sparte": { + "description": "Sparte der Messlokation, z.B. Gas oder Strom", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/bo/Netzlokation.json b/unittests/test_data/bo4e_schemas/bo/Netzlokation.json new file mode 100644 index 0000000..c372782 --- /dev/null +++ b/unittests/test_data/bo4e_schemas/bo/Netzlokation.json @@ -0,0 +1,206 @@ +{ + "description": "Object containing information about a Netzlokation\n\n.. raw:: html\n\n \n\n.. HINT::\n `Netzlokation JSON Schema `_", + "title": "Netzlokation", + "additionalProperties": true, + "properties": { + "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", + "title": " Id", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "_typ": { + "description": "Identifikationsnummer einer Netzlokation, an der Energie entweder verbraucht, oder erzeugt wird", + "default": "NETZLOKATION", + "anyOf": [ + { + "$ref": "../enum/Typ.json#" + }, + { + "type": "null" + } + ] + }, + "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", + "title": " Version", + "default": "v202401.3.2", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "eigenschaftMsbLokation": { + "description": "Eigenschaft des Messstellenbetreibers an der Lokation", + "default": null, + "anyOf": [ + { + "$ref": "../enum/Marktrolle.json#" + }, + { + "type": "null" + } + ] + }, + "grundzustaendigerMsbCodenr": { + "description": "Codenummer des grundzuständigen Messstellenbetreibers, der für diese Netzlokation zuständig ist.", + "title": "Grundzustaendigermsbcodenr", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "konfigurationsprodukte": { + "description": "Produkt-Daten der Netzlokation", + "title": "Konfigurationsprodukte", + "default": null, + "anyOf": [ + { + "items": { + "$ref": "../com/Konfigurationsprodukt.json#" + }, + "type": "array" + }, + { + "type": "null" + } + ] + }, + "lokationsbuendelObjektcode": { + "description": "Lokationsbuendel Code, der die Funktion dieses BOs an der Lokationsbuendelstruktur beschreibt.", + "title": "Lokationsbuendelobjektcode", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "lokationszuordnungen": { + "description": "Lokationszuordnung, um bspw. die zugehörigen Messlokationen anzugeben", + "title": "Lokationszuordnungen", + "default": null, + "anyOf": [ + { + "items": { + "$ref": "Lokationszuordnung.json#" + }, + "type": "array" + }, + { + "type": "null" + } + ] + }, + "netzanschlussleistung": { + "description": "Netzanschlussleistungsmenge der Netzlokation", + "default": null, + "anyOf": [ + { + "$ref": "../com/Menge.json#" + }, + { + "type": "null" + } + ] + }, + "netzlokationsId": { + "description": "Identifikationsnummer einer Netzlokation, an der Energie entweder verbraucht, oder erzeugt wird", + "title": "Netzlokationsid", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "obiskennzahl": { + "description": "Die OBIS-Kennzahl für die Netzlokation", + "title": "Obiskennzahl", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "sparte": { + "description": "Sparte der Netzlokation, z.B. Gas oder Strom.", + "default": null, + "anyOf": [ + { + "$ref": "../enum/Sparte.json#" + }, + { + "type": "null" + } + ] + }, + "steuerkanal": { + "description": "Ob ein Steuerkanal der Netzlokation zugeordnet ist und somit die Netzlokation gesteuert werden kann.", + "title": "Steuerkanal", + "default": null, + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, + "verwendungszweck": { + "description": "Verwendungungszweck der Werte Netzlokation", + "default": null, + "anyOf": [ + { + "$ref": "../com/VerwendungszweckProMarktrolle.json#" + }, + { + "type": "null" + } + ] + }, + "zusatzAttribute": { + "title": "Zusatzattribute", + "default": null, + "anyOf": [ + { + "items": { + "$ref": "../ZusatzAttribut.json#" + }, + "type": "array" + }, + { + "type": "null" + } + ] + } + }, + "type": "object" +} diff --git a/unittests/test_data/bo4e_schemas/bo/Ansprechpartner.json b/unittests/test_data/bo4e_schemas/bo/Person.json similarity index 60% rename from unittests/test_data/bo4e_schemas/bo/Ansprechpartner.json rename to unittests/test_data/bo4e_schemas/bo/Person.json index aa57736..5ece17e 100644 --- a/unittests/test_data/bo4e_schemas/bo/Ansprechpartner.json +++ b/unittests/test_data/bo4e_schemas/bo/Person.json @@ -1,9 +1,10 @@ { - "description": "Object containing information about a Ansprechpartner\n\n.. raw:: html\n\n \n\n.. HINT::\n `Ansprechpartner JSON Schema `_", - "title": "Ansprechpartner", + "description": "Object containing information about a Person\n\n.. raw:: html\n\n \n\n.. HINT::\n `Person JSON Schema `_", + "title": "Person", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,7 +17,8 @@ ] }, "_typ": { - "default": "ANSPRECHPARTNER", + "description": "Mögliche Anrede der Person", + "default": "PERSON", "anyOf": [ { "$ref": "../enum/Typ.json#" @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "adresse": { + "description": "Adresse der Person, falls diese von der Adresse des Geschäftspartners abweicht", "default": null, "anyOf": [ { @@ -50,6 +54,7 @@ ] }, "anrede": { + "description": "Mögliche Anrede der Person", "default": null, "anyOf": [ { @@ -60,23 +65,14 @@ } ] }, - "eMailAdresse": { - "title": "Emailadresse", + "geburtsdatum": { + "description": "Geburtsdatum der Person", + "title": "Geburtsdatum", "default": null, "anyOf": [ { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "geschaeftspartner": { - "default": null, - "anyOf": [ - { - "$ref": "Geschaeftspartner.json#" + "type": "string", + "format": "date-time" }, { "type": "null" @@ -96,6 +92,7 @@ ] }, "kommentar": { + "description": "Weitere Informationen zur Person", "title": "Kommentar", "default": null, "anyOf": [ @@ -107,23 +104,29 @@ } ] }, - "nachname": { - "title": "Nachname", + "kontaktwege": { + "description": "Kontaktwege der Person", + "title": "Kontaktwege", "default": null, "anyOf": [ { - "type": "string" + "items": { + "$ref": "../com/Kontaktweg.json#" + }, + "type": "array" }, { "type": "null" } ] }, - "rufnummer": { + "nachname": { + "description": "Nachname (Familienname) der Person", + "title": "Nachname", "default": null, "anyOf": [ { - "$ref": "../com/Rufnummer.json#" + "type": "string" }, { "type": "null" @@ -131,6 +134,7 @@ ] }, "titel": { + "description": "Möglicher Titel der Person", "default": null, "anyOf": [ { @@ -142,6 +146,7 @@ ] }, "vorname": { + "description": "Vorname der Person", "title": "Vorname", "default": null, "anyOf": [ @@ -168,11 +173,16 @@ } ] }, - "zustaendigkeit": { + "zustaendigkeiten": { + "description": "Liste der Abteilungen und Zuständigkeiten der Person", + "title": "Zustaendigkeiten", "default": null, "anyOf": [ { - "$ref": "../com/Zustaendigkeit.json#" + "items": { + "$ref": "../com/Zustaendigkeit.json#" + }, + "type": "array" }, { "type": "null" diff --git a/unittests/test_data/bo4e_schemas/bo/Preisblatt.json b/unittests/test_data/bo4e_schemas/bo/Preisblatt.json index 0a8555f..5c429ef 100644 --- a/unittests/test_data/bo4e_schemas/bo/Preisblatt.json +++ b/unittests/test_data/bo4e_schemas/bo/Preisblatt.json @@ -1,9 +1,10 @@ { - "description": "Das allgemeine Modell zur Abbildung von Preisen;\nDavon abgeleitet können, über die Zuordnung identifizierender Merkmale, spezielle Preisblatt-Varianten modelliert\nwerden.\n\nDie jeweiligen Sätze von Merkmalen sind in der Grafik ergänzt worden und stellen jeweils eine Ausprägung für die\nverschiedenen Anwendungsfälle der Preisblätter dar.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Preisblatt JSON Schema `_", + "description": "Das allgemeine Modell zur Abbildung von Preisen;\nDavon abgeleitet können, über die Zuordnung identifizierender Merkmale, spezielle Preisblatt-Varianten modelliert\nwerden.\n\nDie jeweiligen Sätze von Merkmalen sind in der Grafik ergänzt worden und stellen jeweils eine Ausprägung für die\nverschiedenen Anwendungsfälle der Preisblätter dar.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Preisblatt JSON Schema `_", "title": "Preisblatt", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Eine Bezeichnung für das Preisblatt", "default": "PREISBLATT", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "bezeichnung": { + "description": "Eine Bezeichnung für das Preisblatt", "title": "Bezeichnung", "default": null, "anyOf": [ @@ -51,6 +55,7 @@ ] }, "gueltigkeit": { + "description": "Der Zeitraum für den der Preis festgelegt ist", "default": null, "anyOf": [ { @@ -62,6 +67,7 @@ ] }, "herausgeber": { + "description": "Der Netzbetreiber, der die Preise veröffentlicht hat", "default": null, "anyOf": [ { @@ -73,6 +79,7 @@ ] }, "preispositionen": { + "description": "Die einzelnen Positionen, die mit dem Preisblatt abgerechnet werden können. Z.B. Arbeitspreis, Grundpreis etc", "title": "Preispositionen", "default": null, "anyOf": [ @@ -88,6 +95,7 @@ ] }, "preisstatus": { + "description": "Merkmal, das anzeigt, ob es sich um vorläufige oder endgültige Preise handelt", "default": null, "anyOf": [ { @@ -99,6 +107,7 @@ ] }, "sparte": { + "description": "Preisblatt gilt für angegebene Sparte", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/bo/PreisblattDienstleistung.json b/unittests/test_data/bo4e_schemas/bo/PreisblattDienstleistung.json index 9e6fd13..7302b36 100644 --- a/unittests/test_data/bo4e_schemas/bo/PreisblattDienstleistung.json +++ b/unittests/test_data/bo4e_schemas/bo/PreisblattDienstleistung.json @@ -1,9 +1,10 @@ { - "description": "Variante des Preisblattmodells zur Abbildung der Preise für wahlfreie Dienstleistungen\n\n.. raw:: html\n\n \n\n.. HINT::\n `PreisblattDienstleistung JSON Schema `_", + "description": "Variante des Preisblattmodells zur Abbildung der Preise für wahlfreie Dienstleistungen\n\n.. raw:: html\n\n \n\n.. HINT::\n `PreisblattDienstleistung JSON Schema `_", "title": "PreisblattDienstleistung", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Die Preise gelten für Marktlokationen der angebebenen Bilanzierungsmethode", "default": "PREISBLATTDIENSTLEISTUNG", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "basisdienstleistung": { + "description": "Dienstleistung, für die der Preis abgebildet wird, z.B. Sperrung/Entsperrung", "default": null, "anyOf": [ { @@ -50,6 +54,7 @@ ] }, "bezeichnung": { + "description": "Eine Bezeichnung für das Preisblatt", "title": "Bezeichnung", "default": null, "anyOf": [ @@ -62,6 +67,7 @@ ] }, "bilanzierungsmethode": { + "description": "Die Preise gelten für Marktlokationen der angebebenen Bilanzierungsmethode", "default": null, "anyOf": [ { @@ -73,6 +79,7 @@ ] }, "geraetedetails": { + "description": "Hier kann der Preis auf bestimmte Geräte eingegrenzt werden. Z.B. auf die Zählergröße", "default": null, "anyOf": [ { @@ -84,6 +91,7 @@ ] }, "gueltigkeit": { + "description": "Der Zeitraum für den der Preis festgelegt ist", "default": null, "anyOf": [ { @@ -95,6 +103,7 @@ ] }, "herausgeber": { + "description": "Der Netzbetreiber, der die Preise veröffentlicht hat", "default": null, "anyOf": [ { @@ -106,6 +115,7 @@ ] }, "inklusiveDienstleistungen": { + "description": "Weitere Dienstleistungen, die im Preis enthalten sind", "title": "Inklusivedienstleistungen", "default": null, "anyOf": [ @@ -121,6 +131,7 @@ ] }, "preispositionen": { + "description": "Die einzelnen Positionen, die mit dem Preisblatt abgerechnet werden können. Z.B. Arbeitspreis, Grundpreis etc", "title": "Preispositionen", "default": null, "anyOf": [ @@ -136,6 +147,7 @@ ] }, "preisstatus": { + "description": "Merkmal, das anzeigt, ob es sich um vorläufige oder endgültige Preise handelt", "default": null, "anyOf": [ { @@ -147,6 +159,7 @@ ] }, "sparte": { + "description": "Preisblatt gilt für angegebene Sparte", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/bo/PreisblattHardware.json b/unittests/test_data/bo4e_schemas/bo/PreisblattHardware.json index d1f71e0..907c25e 100644 --- a/unittests/test_data/bo4e_schemas/bo/PreisblattHardware.json +++ b/unittests/test_data/bo4e_schemas/bo/PreisblattHardware.json @@ -1,9 +1,10 @@ { - "description": "Variante des Preisblattmodells zur Abbildung der Preise für zusätzliche Hardware\n\n.. raw:: html\n\n \n\n.. HINT::\n `PreisblattHardware JSON Schema `_", + "description": "Variante des Preisblattmodells zur Abbildung der Preise für zusätzliche Hardware\n\n.. raw:: html\n\n \n\n.. HINT::\n `PreisblattHardware JSON Schema `_", "title": "PreisblattHardware", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Die Preise gelten für Marktlokationen der angebebenen Bilanzierungsmethode", "default": "PREISBLATTHARDWARE", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "basisgeraet": { + "description": "Der Preis betriftt das hier angegebene Gerät, z.B. ein Tarifschaltgerät", "default": null, "anyOf": [ { @@ -50,6 +54,7 @@ ] }, "bezeichnung": { + "description": "Eine Bezeichnung für das Preisblatt", "title": "Bezeichnung", "default": null, "anyOf": [ @@ -62,6 +67,7 @@ ] }, "bilanzierungsmethode": { + "description": "Die Preise gelten für Marktlokationen der angebebenen Bilanzierungsmethode", "default": null, "anyOf": [ { @@ -73,6 +79,7 @@ ] }, "gueltigkeit": { + "description": "Der Zeitraum für den der Preis festgelegt ist", "default": null, "anyOf": [ { @@ -84,6 +91,7 @@ ] }, "herausgeber": { + "description": "Der Netzbetreiber, der die Preise veröffentlicht hat", "default": null, "anyOf": [ { @@ -95,6 +103,7 @@ ] }, "inklusiveDienstleistungen": { + "description": "Im Preis sind die hier angegebenen Dienstleistungen enthalten, z.B. Jährliche Ablesung", "title": "Inklusivedienstleistungen", "default": null, "anyOf": [ @@ -110,6 +119,7 @@ ] }, "inklusiveGeraete": { + "description": "Im Preis sind die hier angegebenen Geräte mit enthalten, z.B. ein Wandler", "title": "Inklusivegeraete", "default": null, "anyOf": [ @@ -125,6 +135,7 @@ ] }, "messebene": { + "description": "Die Preise gelten für Messlokationen in der angebebenen Netzebene", "default": null, "anyOf": [ { @@ -136,6 +147,7 @@ ] }, "preispositionen": { + "description": "Die einzelnen Positionen, die mit dem Preisblatt abgerechnet werden können. Z.B. Arbeitspreis, Grundpreis etc", "title": "Preispositionen", "default": null, "anyOf": [ @@ -151,6 +163,7 @@ ] }, "preisstatus": { + "description": "Merkmal, das anzeigt, ob es sich um vorläufige oder endgültige Preise handelt", "default": null, "anyOf": [ { @@ -162,6 +175,7 @@ ] }, "sparte": { + "description": "Preisblatt gilt für angegebene Sparte", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/bo/PreisblattKonzessionsabgabe.json b/unittests/test_data/bo4e_schemas/bo/PreisblattKonzessionsabgabe.json index fdc310e..643c289 100644 --- a/unittests/test_data/bo4e_schemas/bo/PreisblattKonzessionsabgabe.json +++ b/unittests/test_data/bo4e_schemas/bo/PreisblattKonzessionsabgabe.json @@ -1,9 +1,10 @@ { - "description": "Die Variante des Preisblattmodells zur Abbildung von allgemeinen Abgaben\n\n.. raw:: html\n\n \n\n.. HINT::\n `PreisblattKonzessionsabgabe JSON Schema `_", + "description": "Die Variante des Preisblattmodells zur Abbildung von allgemeinen Abgaben\n\n.. raw:: html\n\n \n\n.. HINT::\n `PreisblattKonzessionsabgabe JSON Schema `_", "title": "PreisblattKonzessionsabgabe", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Kundegruppe anhand derer die Höhe der Konzessionabgabe festgelegt ist", "default": "PREISBLATTKONZESSIONSABGABE", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "bezeichnung": { + "description": "Eine Bezeichnung für das Preisblatt", "title": "Bezeichnung", "default": null, "anyOf": [ @@ -51,6 +55,7 @@ ] }, "gueltigkeit": { + "description": "Der Zeitraum für den der Preis festgelegt ist", "default": null, "anyOf": [ { @@ -62,6 +67,7 @@ ] }, "herausgeber": { + "description": "Der Netzbetreiber, der die Preise veröffentlicht hat", "default": null, "anyOf": [ { @@ -73,6 +79,7 @@ ] }, "kundengruppeKA": { + "description": "Kundegruppe anhand derer die Höhe der Konzessionabgabe festgelegt ist", "default": null, "anyOf": [ { @@ -84,6 +91,7 @@ ] }, "preispositionen": { + "description": "Die einzelnen Positionen, die mit dem Preisblatt abgerechnet werden können. Z.B. Arbeitspreis, Grundpreis etc", "title": "Preispositionen", "default": null, "anyOf": [ @@ -99,6 +107,7 @@ ] }, "preisstatus": { + "description": "Merkmal, das anzeigt, ob es sich um vorläufige oder endgültige Preise handelt", "default": null, "anyOf": [ { @@ -110,6 +119,7 @@ ] }, "sparte": { + "description": "Preisblatt gilt für angegebene Sparte", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/bo/PreisblattMessung.json b/unittests/test_data/bo4e_schemas/bo/PreisblattMessung.json index 32506ca..a975673 100644 --- a/unittests/test_data/bo4e_schemas/bo/PreisblattMessung.json +++ b/unittests/test_data/bo4e_schemas/bo/PreisblattMessung.json @@ -1,9 +1,10 @@ { - "description": "Variante des Preisblattmodells zur Abbildung der Preise des Messstellenbetriebs und damit verbundener Leistungen\n\n.. raw:: html\n\n \n\n.. HINT::\n `PreisblattMessung JSON Schema `_", + "description": "Variante des Preisblattmodells zur Abbildung der Preise des Messstellenbetriebs und damit verbundener Leistungen\n\n.. raw:: html\n\n \n\n.. HINT::\n `PreisblattMessung JSON Schema `_", "title": "PreisblattMessung", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Die Preise gelten für Marktlokationen der angebebenen Bilanzierungsmethode", "default": "PREISBLATTMESSUNG", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "bezeichnung": { + "description": "Eine Bezeichnung für das Preisblatt", "title": "Bezeichnung", "default": null, "anyOf": [ @@ -51,6 +55,7 @@ ] }, "bilanzierungsmethode": { + "description": "Die Preise gelten für Marktlokationen der angebebenen Bilanzierungsmethode", "default": null, "anyOf": [ { @@ -62,6 +67,7 @@ ] }, "gueltigkeit": { + "description": "Der Zeitraum für den der Preis festgelegt ist", "default": null, "anyOf": [ { @@ -73,6 +79,7 @@ ] }, "herausgeber": { + "description": "Der Netzbetreiber, der die Preise veröffentlicht hat", "default": null, "anyOf": [ { @@ -84,6 +91,7 @@ ] }, "inklusiveDienstleistungen": { + "description": "Im Preis sind die hier angegebenen Dienstleistungen enthalten, z.B. Jährliche Ablesung", "title": "Inklusivedienstleistungen", "default": null, "anyOf": [ @@ -99,6 +107,7 @@ ] }, "inklusiveGeraete": { + "description": "Im Preis sind die hier angegebenen Geräte mit enthalten, z.B. ein Wandler", "title": "Inklusivegeraete", "default": null, "anyOf": [ @@ -114,6 +123,7 @@ ] }, "messebene": { + "description": "Die Preise gelten für Messlokationen in der angebebenen Netzebene", "default": null, "anyOf": [ { @@ -125,6 +135,7 @@ ] }, "preispositionen": { + "description": "Die einzelnen Positionen, die mit dem Preisblatt abgerechnet werden können. Z.B. Arbeitspreis, Grundpreis etc", "title": "Preispositionen", "default": null, "anyOf": [ @@ -140,6 +151,7 @@ ] }, "preisstatus": { + "description": "Merkmal, das anzeigt, ob es sich um vorläufige oder endgültige Preise handelt", "default": null, "anyOf": [ { @@ -151,6 +163,7 @@ ] }, "sparte": { + "description": "Preisblatt gilt für angegebene Sparte", "default": null, "anyOf": [ { @@ -162,6 +175,7 @@ ] }, "zaehler": { + "description": "Der Preis betrifft den hier angegebenen Zähler, z.B. einen Drehstromzähler", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/bo/PreisblattNetznutzung.json b/unittests/test_data/bo4e_schemas/bo/PreisblattNetznutzung.json index 72b6925..6cfaefa 100644 --- a/unittests/test_data/bo4e_schemas/bo/PreisblattNetznutzung.json +++ b/unittests/test_data/bo4e_schemas/bo/PreisblattNetznutzung.json @@ -1,9 +1,10 @@ { - "description": "Die Variante des Preisblattmodells zur Abbildung der Netznutzungspreise\n\n.. raw:: html\n\n \n\n.. HINT::\n `PreisblattNetznutzung JSON Schema `_", + "description": "Die Variante des Preisblattmodells zur Abbildung der Netznutzungspreise\n\n.. raw:: html\n\n \n\n.. HINT::\n `PreisblattNetznutzung JSON Schema `_", "title": "PreisblattNetznutzung", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Die Preise gelten für Marktlokationen der angebebenen Bilanzierungsmethode", "default": "PREISBLATTNETZNUTZUNG", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "bezeichnung": { + "description": "Eine Bezeichnung für das Preisblatt", "title": "Bezeichnung", "default": null, "anyOf": [ @@ -51,6 +55,7 @@ ] }, "bilanzierungsmethode": { + "description": "Die Preise gelten für Marktlokationen der angebebenen Bilanzierungsmethode", "default": null, "anyOf": [ { @@ -62,6 +67,7 @@ ] }, "gueltigkeit": { + "description": "Der Zeitraum für den der Preis festgelegt ist", "default": null, "anyOf": [ { @@ -73,6 +79,7 @@ ] }, "herausgeber": { + "description": "Der Netzbetreiber, der die Preise veröffentlicht hat", "default": null, "anyOf": [ { @@ -95,6 +102,7 @@ ] }, "netzebene": { + "description": "Die Preise gelten für Marktlokationen in der angebebenen Netzebene", "default": null, "anyOf": [ { @@ -106,6 +114,7 @@ ] }, "preispositionen": { + "description": "Die einzelnen Positionen, die mit dem Preisblatt abgerechnet werden können. Z.B. Arbeitspreis, Grundpreis etc", "title": "Preispositionen", "default": null, "anyOf": [ @@ -121,6 +130,7 @@ ] }, "preisstatus": { + "description": "Merkmal, das anzeigt, ob es sich um vorläufige oder endgültige Preise handelt", "default": null, "anyOf": [ { @@ -132,6 +142,7 @@ ] }, "sparte": { + "description": "Preisblatt gilt für angegebene Sparte", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/bo/Rechnung.json b/unittests/test_data/bo4e_schemas/bo/Rechnung.json index c20d2f7..7e1d898 100644 --- a/unittests/test_data/bo4e_schemas/bo/Rechnung.json +++ b/unittests/test_data/bo4e_schemas/bo/Rechnung.json @@ -1,9 +1,10 @@ { - "description": "Modell für die Abbildung von Rechnungen und Netznutzungsrechnungen im Kontext der Energiewirtschaft;\n\n.. raw:: html\n\n \n\n.. HINT::\n `Rechnung JSON Schema `_", + "description": "Modell für die Abbildung von Rechnungen und Netznutzungsrechnungen im Kontext der Energiewirtschaft;\n\n.. raw:: html\n\n \n\n.. HINT::\n `Rechnung JSON Schema `_", "title": "Rechnung", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Der Zeitraum der zugrunde liegenden Lieferung zur Rechnung", "default": "RECHNUNG", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "faelligkeitsdatum": { + "description": "Zu diesem Datum ist die Zahlung fällig", "title": "Faelligkeitsdatum", "default": null, "anyOf": [ @@ -52,6 +56,7 @@ ] }, "gesamtbrutto": { + "description": "Die Summe aus Netto- und Steuerbetrag", "default": null, "anyOf": [ { @@ -63,6 +68,7 @@ ] }, "gesamtnetto": { + "description": "Die Summe der Nettobeträge der Rechnungsteile", "default": null, "anyOf": [ { @@ -74,6 +80,7 @@ ] }, "gesamtsteuer": { + "description": "Die Summe der Steuerbeträge der Rechnungsteile", "default": null, "anyOf": [ { @@ -85,6 +92,7 @@ ] }, "istOriginal": { + "description": "Kennzeichen, ob es sich um ein Original (true) oder eine Kopie handelt (false)", "title": "Istoriginal", "default": null, "anyOf": [ @@ -97,6 +105,7 @@ ] }, "istSimuliert": { + "description": "Kennzeichen, ob es sich um eine simulierte Rechnung, z.B. zur Rechnungsprüfung handelt", "title": "Istsimuliert", "default": null, "anyOf": [ @@ -109,6 +118,7 @@ ] }, "istStorno": { + "description": "Eine im Verwendungskontext eindeutige Nummer für die Rechnung", "title": "Iststorno", "default": null, "anyOf": [ @@ -121,6 +131,7 @@ ] }, "marktlokation": { + "description": "Marktlokation, auf die sich die Rechnung bezieht", "default": null, "anyOf": [ { @@ -132,6 +143,7 @@ ] }, "messlokation": { + "description": "Messlokation, auf die sich die Rechnung bezieht", "default": null, "anyOf": [ { @@ -143,6 +155,7 @@ ] }, "netznutzungrechnungsart": { + "description": "Aus der INVOIC entnommen, befüllt wenn es sich um eine Netznutzungsrechnung handelt", "default": null, "anyOf": [ { @@ -154,6 +167,7 @@ ] }, "netznutzungrechnungstyp": { + "description": "Aus der INVOIC entnommen, befüllt wenn es sich um eine Netznutzungsrechnung handelt", "default": null, "anyOf": [ { @@ -165,6 +179,7 @@ ] }, "originalRechnungsnummer": { + "description": "Im Falle einer Stornorechnung (storno = true) steht hier die Rechnungsnummer der stornierten Rechnung", "title": "Originalrechnungsnummer", "default": null, "anyOf": [ @@ -177,6 +192,7 @@ ] }, "rabattBrutto": { + "description": "Gesamtrabatt auf den Bruttobetrag", "default": null, "anyOf": [ { @@ -188,6 +204,7 @@ ] }, "rechnungsdatum": { + "description": "Ausstellungsdatum der Rechnung", "title": "Rechnungsdatum", "default": null, "anyOf": [ @@ -201,6 +218,7 @@ ] }, "rechnungsempfaenger": { + "description": "Der Aussteller der Rechnung, die Rollencodenummer kennt man über den im Geschäftspartner verlinkten Marktteilnehmer", "default": null, "anyOf": [ { @@ -212,6 +230,7 @@ ] }, "rechnungsersteller": { + "description": "Der Aussteller der Rechnung, die Rollencodenummer kennt man über den im Geschäftspartner verlinkten Marktteilnehmer", "default": null, "anyOf": [ { @@ -223,6 +242,7 @@ ] }, "rechnungsnummer": { + "description": "Eine im Verwendungskontext eindeutige Nummer für die Rechnung", "title": "Rechnungsnummer", "default": null, "anyOf": [ @@ -235,6 +255,7 @@ ] }, "rechnungsperiode": { + "description": "Der Zeitraum der zugrunde liegenden Lieferung zur Rechnung", "default": null, "anyOf": [ { @@ -246,6 +267,7 @@ ] }, "rechnungspositionen": { + "description": "Die Rechnungspositionen", "title": "Rechnungspositionen", "default": null, "anyOf": [ @@ -261,6 +283,7 @@ ] }, "rechnungsstatus": { + "description": "Status der Rechnung zur Kennzeichnung des Bearbeitungsstandes", "default": null, "anyOf": [ { @@ -272,6 +295,7 @@ ] }, "rechnungstitel": { + "description": "Bezeichnung für die vorliegende Rechnung", "title": "Rechnungstitel", "default": null, "anyOf": [ @@ -284,6 +308,7 @@ ] }, "rechnungstyp": { + "description": "Ein kontextbezogender Rechnungstyp, z.B. Netznutzungsrechnung", "default": null, "anyOf": [ { @@ -295,6 +320,7 @@ ] }, "sparte": { + "description": "Sparte (Strom, Gas ...) für die die Rechnung ausgestellt ist", "default": null, "anyOf": [ { @@ -306,6 +332,7 @@ ] }, "steuerbetraege": { + "description": "Sparte (Strom, Gas ...) für die die Rechnung ausgestellt ist", "title": "Steuerbetraege", "default": null, "anyOf": [ @@ -321,6 +348,7 @@ ] }, "vorausgezahlt": { + "description": "Die Summe evtl. vorausgezahlter Beträge, z.B. Abschläge. Angabe als Bruttowert", "default": null, "anyOf": [ { @@ -332,6 +360,7 @@ ] }, "zuZahlen": { + "description": "Der zu zahlende Betrag, der sich aus (gesamtbrutto - vorausbezahlt - rabattBrutto) ergibt", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/bo/Region.json b/unittests/test_data/bo4e_schemas/bo/Region.json index 0a65898..aad3eaf 100644 --- a/unittests/test_data/bo4e_schemas/bo/Region.json +++ b/unittests/test_data/bo4e_schemas/bo/Region.json @@ -1,9 +1,10 @@ { - "description": "Modellierung einer Region als Menge von Kriterien, die eine Region beschreiben\n\n.. raw:: html\n\n \n\n.. HINT::\n `Region JSON Schema `_", + "description": "Modellierung einer Region als Menge von Kriterien, die eine Region beschreiben\n\n.. raw:: html\n\n \n\n.. HINT::\n `Region JSON Schema `_", "title": "Region", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Bezeichnung der Region", "default": "REGION", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "bezeichnung": { + "description": "Bezeichnung der Region", "title": "Bezeichnung", "default": null, "anyOf": [ @@ -51,6 +55,7 @@ ] }, "negativListe": { + "description": "Negativliste der Kriterien zur Definition der Region", "title": "Negativliste", "default": null, "anyOf": [ @@ -66,6 +71,7 @@ ] }, "positivListe": { + "description": "Positivliste der Kriterien zur Definition der Region", "title": "Positivliste", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/bo/Regionaltarif.json b/unittests/test_data/bo4e_schemas/bo/Regionaltarif.json index 63af897..ba15687 100644 --- a/unittests/test_data/bo4e_schemas/bo/Regionaltarif.json +++ b/unittests/test_data/bo4e_schemas/bo/Regionaltarif.json @@ -1,9 +1,10 @@ { - "description": ".. raw:: html\n\n \n\n.. HINT::\n `Regionaltarif JSON Schema `_", + "description": ".. raw:: html\n\n \n\n.. HINT::\n `Regionaltarif JSON Schema `_", "title": "Regionaltarif", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -27,8 +28,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +41,7 @@ ] }, "anbieter": { + "description": "Der Marktteilnehmer (Lieferant), der diesen Tarif anbietet", "default": null, "anyOf": [ { @@ -50,6 +53,7 @@ ] }, "anbietername": { + "description": "Der Name des Marktpartners, der den Tarif anbietet", "title": "Anbietername", "default": null, "anyOf": [ @@ -75,6 +79,7 @@ ] }, "bemerkung": { + "description": "Freitext", "title": "Bemerkung", "default": null, "anyOf": [ @@ -98,6 +103,7 @@ ] }, "bezeichnung": { + "description": "Name des Tarifs", "title": "Bezeichnung", "default": null, "anyOf": [ @@ -110,6 +116,7 @@ ] }, "energiemix": { + "description": "Der Energiemix, der für diesen Tarif gilt", "default": null, "anyOf": [ { @@ -121,6 +128,7 @@ ] }, "kundentypen": { + "description": "Kundentypen für den der Tarif gilt, z.B. Privatkunden", "title": "Kundentypen", "default": null, "anyOf": [ @@ -164,6 +172,7 @@ ] }, "registeranzahl": { + "description": "Die Art des Tarifes, z.B. Eintarif oder Mehrtarif", "default": null, "anyOf": [ { @@ -175,6 +184,7 @@ ] }, "sparte": { + "description": "Strom oder Gas, etc.", "default": null, "anyOf": [ { @@ -212,6 +222,7 @@ ] }, "tarifmerkmale": { + "description": "Weitere Merkmale des Tarifs, z.B. Festpreis oder Vorkasse", "title": "Tarifmerkmale", "default": null, "anyOf": [ @@ -242,6 +253,7 @@ ] }, "tariftyp": { + "description": "Hinweis auf den Tariftyp, z.B. Grundversorgung oder Sondertarif", "default": null, "anyOf": [ { @@ -253,6 +265,7 @@ ] }, "vertragskonditionen": { + "description": "Mindestlaufzeiten und Kündigungsfristen zusammengefasst", "default": null, "anyOf": [ { @@ -264,6 +277,7 @@ ] }, "website": { + "description": "Internetseite auf dem der Tarif zu finden ist", "title": "Website", "default": null, "anyOf": [ @@ -276,6 +290,7 @@ ] }, "zeitlicheGueltigkeit": { + "description": "Angabe, in welchem Zeitraum der Tarif gültig ist", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/bo/Standorteigenschaften.json b/unittests/test_data/bo4e_schemas/bo/Standorteigenschaften.json index 74ab176..a0dc5f0 100644 --- a/unittests/test_data/bo4e_schemas/bo/Standorteigenschaften.json +++ b/unittests/test_data/bo4e_schemas/bo/Standorteigenschaften.json @@ -1,9 +1,10 @@ { - "description": "Modelliert die regionalen und spartenspezifischen Eigenschaften einer gegebenen Adresse.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Standorteigenschaften JSON Schema `_", + "description": "Modelliert die regionalen und spartenspezifischen Eigenschaften einer gegebenen Adresse.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Standorteigenschaften JSON Schema `_", "title": "Standorteigenschaften", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Eigenschaften zur Sparte Strom", "default": "STANDORTEIGENSCHAFTEN", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "eigenschaftenGas": { + "description": "Eigenschaften zur Sparte Gas", "default": null, "anyOf": [ { @@ -50,6 +54,7 @@ ] }, "eigenschaftenStrom": { + "description": "Eigenschaften zur Sparte Strom", "title": "Eigenschaftenstrom", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/bo/SteuerbareRessource.json b/unittests/test_data/bo4e_schemas/bo/SteuerbareRessource.json new file mode 100644 index 0000000..9d58e07 --- /dev/null +++ b/unittests/test_data/bo4e_schemas/bo/SteuerbareRessource.json @@ -0,0 +1,156 @@ +{ + "description": "Object containing information about a steuerbare Ressource\n\n.. raw:: html\n\n \n\n.. HINT::\n `SteuerbareRessource JSON Schema `_", + "title": "SteuerbareRessource", + "additionalProperties": true, + "properties": { + "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", + "title": " Id", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "_typ": { + "description": "Id der steuerbaren Ressource", + "default": "STEUERBARERESSOURCE", + "anyOf": [ + { + "$ref": "../enum/Typ.json#" + }, + { + "type": "null" + } + ] + }, + "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", + "title": " Version", + "default": "v202401.3.2", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "eigenschaftMsbLokation": { + "description": "Eigenschaft des Messstellenbetreibers an der Lokation", + "default": null, + "anyOf": [ + { + "$ref": "../enum/Marktrolle.json#" + }, + { + "type": "null" + } + ] + }, + "konfigurationsprodukte": { + "description": "Produkt-Daten der Steuerbaren Ressource", + "title": "Konfigurationsprodukte", + "default": null, + "anyOf": [ + { + "items": { + "$ref": "../com/Konfigurationsprodukt.json#" + }, + "type": "array" + }, + { + "type": "null" + } + ] + }, + "lokationsbuendelObjektcode": { + "description": "Lokationsbuendel Code, der die Funktion dieses BOs an der Lokationsbuendelstruktur beschreibt.", + "title": "Lokationsbuendelobjektcode", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "lokationszuordnungen": { + "description": "Lokationszuordnung, um bspw. die zugehörigen Messlokationen anzugeben", + "title": "Lokationszuordnungen", + "default": null, + "anyOf": [ + { + "items": { + "$ref": "Lokationszuordnung.json#" + }, + "type": "array" + }, + { + "type": "null" + } + ] + }, + "steuerbareRessourceId": { + "description": "Id der steuerbaren Ressource", + "title": "Steuerbareressourceid", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "steuerkanalLeistungsbeschreibung": { + "description": "Leistungsbeschreibung des Steuerkanals", + "default": null, + "anyOf": [ + { + "$ref": "../enum/SteuerkanalLeistungsbeschreibung.json#" + }, + { + "type": "null" + } + ] + }, + "zugeordneteMsbCodenummer": { + "description": "Angabe des Messstellenbetreibers, der der Steuerbaren Ressource zugeordnet ist.", + "title": "Zugeordnetemsbcodenummer", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "zusatzAttribute": { + "title": "Zusatzattribute", + "default": null, + "anyOf": [ + { + "items": { + "$ref": "../ZusatzAttribut.json#" + }, + "type": "array" + }, + { + "type": "null" + } + ] + } + }, + "type": "object" +} diff --git a/unittests/test_data/bo4e_schemas/bo/Tarif.json b/unittests/test_data/bo4e_schemas/bo/Tarif.json index f4e6faa..c88c3d4 100644 --- a/unittests/test_data/bo4e_schemas/bo/Tarif.json +++ b/unittests/test_data/bo4e_schemas/bo/Tarif.json @@ -1,9 +1,10 @@ { - "description": "Abbildung eines Tarifs mit regionaler Zuordnung von Preisen und Auf- und Abschlägen\n\n.. raw:: html\n\n \n\n.. HINT::\n `Tarif JSON Schema `_", + "description": "Abbildung eines Tarifs mit regionaler Zuordnung von Preisen und Auf- und Abschlägen\n\n.. raw:: html\n\n \n\n.. HINT::\n `Tarif JSON Schema `_", "title": "Tarif", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Gibt an, wann der Preis zuletzt angepasst wurde", "default": "TARIF", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "anbieter": { + "description": "Der Marktteilnehmer (Lieferant), der diesen Tarif anbietet", "default": null, "anyOf": [ { @@ -50,6 +54,7 @@ ] }, "anbietername": { + "description": "Der Name des Marktpartners, der den Tarif anbietet", "title": "Anbietername", "default": null, "anyOf": [ @@ -75,6 +80,7 @@ ] }, "bemerkung": { + "description": "Freitext", "title": "Bemerkung", "default": null, "anyOf": [ @@ -87,6 +93,7 @@ ] }, "berechnungsparameter": { + "description": "Für die Berechnung der Kosten sind die hier abgebildeten Parameter heranzuziehen", "default": null, "anyOf": [ { @@ -98,6 +105,7 @@ ] }, "bezeichnung": { + "description": "Name des Tarifs", "title": "Bezeichnung", "default": null, "anyOf": [ @@ -110,6 +118,7 @@ ] }, "energiemix": { + "description": "Der Energiemix, der für diesen Tarif gilt", "default": null, "anyOf": [ { @@ -121,6 +130,7 @@ ] }, "kundentypen": { + "description": "Kundentypen für den der Tarif gilt, z.B. Privatkunden", "title": "Kundentypen", "default": null, "anyOf": [ @@ -136,6 +146,7 @@ ] }, "preisgarantie": { + "description": "Preisgarantie für diesen Tarif", "default": null, "anyOf": [ { @@ -147,6 +158,7 @@ ] }, "preisstand": { + "description": "Gibt an, wann der Preis zuletzt angepasst wurde", "title": "Preisstand", "default": null, "anyOf": [ @@ -160,6 +172,7 @@ ] }, "registeranzahl": { + "description": "Die Art des Tarifes, z.B. Eintarif oder Mehrtarif", "default": null, "anyOf": [ { @@ -171,6 +184,7 @@ ] }, "sparte": { + "description": "Strom oder Gas, etc.", "default": null, "anyOf": [ { @@ -182,6 +196,7 @@ ] }, "tarifAufAbschlaege": { + "description": "Auf- und Abschläge auf die Preise oder Kosten mit regionaler Eingrenzung", "title": "Tarifaufabschlaege", "default": null, "anyOf": [ @@ -197,6 +212,7 @@ ] }, "tarifeinschraenkung": { + "description": "Die Bedingungen und Einschränkungen unter denen ein Tarif angewendet werden kann", "default": null, "anyOf": [ { @@ -208,6 +224,7 @@ ] }, "tarifmerkmale": { + "description": "Weitere Merkmale des Tarifs, z.B. Festpreis oder Vorkasse", "title": "Tarifmerkmale", "default": null, "anyOf": [ @@ -223,6 +240,7 @@ ] }, "tarifpreise": { + "description": "Die festgelegten Preise mit regionaler Eingrenzung z.B. für Arbeitspreis, Grundpreis etc.", "title": "Tarifpreise", "default": null, "anyOf": [ @@ -238,6 +256,7 @@ ] }, "tariftyp": { + "description": "Hinweis auf den Tariftyp, z.B. Grundversorgung oder Sondertarif", "default": null, "anyOf": [ { @@ -249,6 +268,7 @@ ] }, "vertragskonditionen": { + "description": "Mindestlaufzeiten und Kündigungsfristen zusammengefasst", "default": null, "anyOf": [ { @@ -260,6 +280,7 @@ ] }, "website": { + "description": "Internetseite auf dem der Tarif zu finden ist", "title": "Website", "default": null, "anyOf": [ @@ -272,6 +293,7 @@ ] }, "zeitlicheGueltigkeit": { + "description": "Angabe, in welchem Zeitraum der Tarif gültig ist", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/bo/Tarifinfo.json b/unittests/test_data/bo4e_schemas/bo/Tarifinfo.json index ba654fc..5939fbd 100644 --- a/unittests/test_data/bo4e_schemas/bo/Tarifinfo.json +++ b/unittests/test_data/bo4e_schemas/bo/Tarifinfo.json @@ -1,9 +1,10 @@ { - "description": "Das BO Tarifinfo liefert die Merkmale, die einen Endkundentarif identifizierbar machen.\nDieses BO dient als Basis für weitere BOs mit erweiterten Anwendungsmöglichkeiten.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Tarifinfo JSON Schema `_", + "description": "Das BO Tarifinfo liefert die Merkmale, die einen Endkundentarif identifizierbar machen.\nDieses BO dient als Basis für weitere BOs mit erweiterten Anwendungsmöglichkeiten.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Tarifinfo JSON Schema `_", "title": "Tarifinfo", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Name des Tarifs", "default": "TARIFINFO", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "anbieter": { + "description": "Der Marktteilnehmer (Lieferant), der diesen Tarif anbietet", "default": null, "anyOf": [ { @@ -50,6 +54,7 @@ ] }, "anbietername": { + "description": "Der Name des Marktpartners, der den Tarif anbietet", "title": "Anbietername", "default": null, "anyOf": [ @@ -75,6 +80,7 @@ ] }, "bemerkung": { + "description": "Freitext", "title": "Bemerkung", "default": null, "anyOf": [ @@ -87,6 +93,7 @@ ] }, "bezeichnung": { + "description": "Name des Tarifs", "title": "Bezeichnung", "default": null, "anyOf": [ @@ -99,6 +106,7 @@ ] }, "energiemix": { + "description": "Der Energiemix, der für diesen Tarif gilt", "default": null, "anyOf": [ { @@ -110,6 +118,7 @@ ] }, "kundentypen": { + "description": "Kundentypen für den der Tarif gilt, z.B. Privatkunden", "title": "Kundentypen", "default": null, "anyOf": [ @@ -125,6 +134,7 @@ ] }, "registeranzahl": { + "description": "Die Art des Tarifes, z.B. Eintarif oder Mehrtarif", "default": null, "anyOf": [ { @@ -136,6 +146,7 @@ ] }, "sparte": { + "description": "Strom oder Gas, etc.", "default": null, "anyOf": [ { @@ -147,6 +158,7 @@ ] }, "tarifmerkmale": { + "description": "Weitere Merkmale des Tarifs, z.B. Festpreis oder Vorkasse", "title": "Tarifmerkmale", "default": null, "anyOf": [ @@ -162,6 +174,7 @@ ] }, "tariftyp": { + "description": "Hinweis auf den Tariftyp, z.B. Grundversorgung oder Sondertarif", "default": null, "anyOf": [ { @@ -173,6 +186,7 @@ ] }, "vertragskonditionen": { + "description": "Mindestlaufzeiten und Kündigungsfristen zusammengefasst", "default": null, "anyOf": [ { @@ -184,6 +198,7 @@ ] }, "website": { + "description": "Internetseite auf dem der Tarif zu finden ist", "title": "Website", "default": null, "anyOf": [ @@ -196,6 +211,7 @@ ] }, "zeitlicheGueltigkeit": { + "description": "Angabe, in welchem Zeitraum der Tarif gültig ist", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/bo/Tarifkosten.json b/unittests/test_data/bo4e_schemas/bo/Tarifkosten.json index d8cee36..10f58a5 100644 --- a/unittests/test_data/bo4e_schemas/bo/Tarifkosten.json +++ b/unittests/test_data/bo4e_schemas/bo/Tarifkosten.json @@ -1,9 +1,10 @@ { - "description": "Objekt zur Kommunikation von Kosten, die im Rahmen der Tarifanwendung entstehen\n\n.. raw:: html\n\n \n\n.. HINT::\n `Tarifkosten JSON Schema `_", + "description": "Objekt zur Kommunikation von Kosten, die im Rahmen der Tarifanwendung entstehen\n\n.. raw:: html\n\n \n\n.. HINT::\n `Tarifkosten JSON Schema `_", "title": "Tarifkosten", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Name des Tarifs", "default": "TARIFKOSTEN", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "anbieter": { + "description": "Der Marktteilnehmer (Lieferant), der diesen Tarif anbietet", "default": null, "anyOf": [ { @@ -50,6 +54,7 @@ ] }, "anbietername": { + "description": "Der Name des Marktpartners, der den Tarif anbietet", "title": "Anbietername", "default": null, "anyOf": [ @@ -75,6 +80,7 @@ ] }, "bemerkung": { + "description": "Freitext", "title": "Bemerkung", "default": null, "anyOf": [ @@ -87,6 +93,7 @@ ] }, "bezeichnung": { + "description": "Name des Tarifs", "title": "Bezeichnung", "default": null, "anyOf": [ @@ -99,6 +106,7 @@ ] }, "energiemix": { + "description": "Der Energiemix, der für diesen Tarif gilt", "default": null, "anyOf": [ { @@ -121,6 +129,7 @@ ] }, "kundentypen": { + "description": "Kundentypen für den der Tarif gilt, z.B. Privatkunden", "title": "Kundentypen", "default": null, "anyOf": [ @@ -136,6 +145,7 @@ ] }, "registeranzahl": { + "description": "Die Art des Tarifes, z.B. Eintarif oder Mehrtarif", "default": null, "anyOf": [ { @@ -147,6 +157,7 @@ ] }, "sparte": { + "description": "Strom oder Gas, etc.", "default": null, "anyOf": [ { @@ -158,6 +169,7 @@ ] }, "tarifmerkmale": { + "description": "Weitere Merkmale des Tarifs, z.B. Festpreis oder Vorkasse", "title": "Tarifmerkmale", "default": null, "anyOf": [ @@ -173,6 +185,7 @@ ] }, "tariftyp": { + "description": "Hinweis auf den Tariftyp, z.B. Grundversorgung oder Sondertarif", "default": null, "anyOf": [ { @@ -184,6 +197,7 @@ ] }, "vertragskonditionen": { + "description": "Mindestlaufzeiten und Kündigungsfristen zusammengefasst", "default": null, "anyOf": [ { @@ -195,6 +209,7 @@ ] }, "website": { + "description": "Internetseite auf dem der Tarif zu finden ist", "title": "Website", "default": null, "anyOf": [ @@ -207,6 +222,7 @@ ] }, "zeitlicheGueltigkeit": { + "description": "Angabe, in welchem Zeitraum der Tarif gültig ist", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/bo/Tarifpreisblatt.json b/unittests/test_data/bo4e_schemas/bo/Tarifpreisblatt.json index 4e7e9f8..7f468a5 100644 --- a/unittests/test_data/bo4e_schemas/bo/Tarifpreisblatt.json +++ b/unittests/test_data/bo4e_schemas/bo/Tarifpreisblatt.json @@ -1,9 +1,10 @@ { - "description": "Tarifinformation mit Preisen, Aufschlägen und Berechnungssystematik\n\n.. raw:: html\n\n \n\n.. HINT::\n `Tarifpreisblatt JSON Schema `_", + "description": "Tarifinformation mit Preisen, Aufschlägen und Berechnungssystematik\n\n.. raw:: html\n\n \n\n.. HINT::\n `Tarifpreisblatt JSON Schema `_", "title": "Tarifpreisblatt", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Gibt an, wann der Preis zuletzt angepasst wurde", "default": "TARIFPREISBLATT", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "anbieter": { + "description": "Der Marktteilnehmer (Lieferant), der diesen Tarif anbietet", "default": null, "anyOf": [ { @@ -50,6 +54,7 @@ ] }, "anbietername": { + "description": "Der Name des Marktpartners, der den Tarif anbietet", "title": "Anbietername", "default": null, "anyOf": [ @@ -75,6 +80,7 @@ ] }, "bemerkung": { + "description": "Freitext", "title": "Bemerkung", "default": null, "anyOf": [ @@ -87,6 +93,7 @@ ] }, "berechnungsparameter": { + "description": "Für die Berechnung der Kosten sind die hier abgebildeten Parameter heranzuziehen", "default": null, "anyOf": [ { @@ -98,6 +105,7 @@ ] }, "bezeichnung": { + "description": "Name des Tarifs", "title": "Bezeichnung", "default": null, "anyOf": [ @@ -110,6 +118,7 @@ ] }, "energiemix": { + "description": "Der Energiemix, der für diesen Tarif gilt", "default": null, "anyOf": [ { @@ -121,6 +130,7 @@ ] }, "kundentypen": { + "description": "Kundentypen für den der Tarif gilt, z.B. Privatkunden", "title": "Kundentypen", "default": null, "anyOf": [ @@ -136,6 +146,7 @@ ] }, "preisgarantie": { + "description": "Festlegung von Garantien für bestimmte Preisanteile", "default": null, "anyOf": [ { @@ -147,6 +158,7 @@ ] }, "preisstand": { + "description": "Gibt an, wann der Preis zuletzt angepasst wurde", "title": "Preisstand", "default": null, "anyOf": [ @@ -160,6 +172,7 @@ ] }, "registeranzahl": { + "description": "Die Art des Tarifes, z.B. Eintarif oder Mehrtarif", "default": null, "anyOf": [ { @@ -171,6 +184,7 @@ ] }, "sparte": { + "description": "Strom oder Gas, etc.", "default": null, "anyOf": [ { @@ -182,6 +196,7 @@ ] }, "tarifAufAbschlaege": { + "description": "Auf- und Abschläge auf die Preise oder Kosten", "title": "Tarifaufabschlaege", "default": null, "anyOf": [ @@ -197,6 +212,7 @@ ] }, "tarifeinschraenkung": { + "description": "Die Bedingungen und Einschränkungen unter denen ein Tarif angewendet werden kann", "default": null, "anyOf": [ { @@ -208,6 +224,7 @@ ] }, "tarifmerkmale": { + "description": "Weitere Merkmale des Tarifs, z.B. Festpreis oder Vorkasse", "title": "Tarifmerkmale", "default": null, "anyOf": [ @@ -223,6 +240,7 @@ ] }, "tarifpreise": { + "description": "Die festgelegten Preise, z.B. für Arbeitspreis, Grundpreis etc.", "title": "Tarifpreise", "default": null, "anyOf": [ @@ -238,6 +256,7 @@ ] }, "tariftyp": { + "description": "Hinweis auf den Tariftyp, z.B. Grundversorgung oder Sondertarif", "default": null, "anyOf": [ { @@ -249,6 +268,7 @@ ] }, "vertragskonditionen": { + "description": "Mindestlaufzeiten und Kündigungsfristen zusammengefasst", "default": null, "anyOf": [ { @@ -260,6 +280,7 @@ ] }, "website": { + "description": "Internetseite auf dem der Tarif zu finden ist", "title": "Website", "default": null, "anyOf": [ @@ -272,6 +293,7 @@ ] }, "zeitlicheGueltigkeit": { + "description": "Angabe, in welchem Zeitraum der Tarif gültig ist", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/bo/TechnischeRessource.json b/unittests/test_data/bo4e_schemas/bo/TechnischeRessource.json new file mode 100644 index 0000000..1e3de23 --- /dev/null +++ b/unittests/test_data/bo4e_schemas/bo/TechnischeRessource.json @@ -0,0 +1,250 @@ +{ + "description": "Object containing information about a technische Ressource\n\n.. raw:: html\n\n \n\n.. HINT::\n `TechnischeRessource JSON Schema `_", + "title": "TechnischeRessource", + "additionalProperties": true, + "properties": { + "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", + "title": " Id", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "_typ": { + "description": "Identifikationsnummer einer technischen Ressource", + "default": "TECHNISCHERESSOURCE", + "anyOf": [ + { + "$ref": "../enum/Typ.json#" + }, + { + "type": "null" + } + ] + }, + "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", + "title": " Version", + "default": "v202401.3.2", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "emobilitaetsart": { + "description": "Art der E-Mobilität", + "default": null, + "anyOf": [ + { + "$ref": "../enum/EMobilitaetsart.json#" + }, + { + "type": "null" + } + ] + }, + "erzeugungsart": { + "description": "Art der Erzeugung der Energie", + "default": null, + "anyOf": [ + { + "$ref": "../enum/Erzeugungsart.json#" + }, + { + "type": "null" + } + ] + }, + "lokationsbuendelObjektcode": { + "description": "Lokationsbuendel Code, der die Funktion dieses BOs an der Lokationsbuendelstruktur beschreibt.", + "title": "Lokationsbuendelobjektcode", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "lokationszuordnungen": { + "description": "Lokationszuordnung, um bspw. die zugehörigen Messlokationen anzugeben", + "title": "Lokationszuordnungen", + "default": null, + "anyOf": [ + { + "items": { + "$ref": "Lokationszuordnung.json#" + }, + "type": "array" + }, + { + "type": "null" + } + ] + }, + "nennleistungabgabe": { + "description": "Nennleistung (Abgabe)", + "default": null, + "anyOf": [ + { + "$ref": "../com/Menge.json#" + }, + { + "type": "null" + } + ] + }, + "nennleistungaufnahme": { + "description": "Nennleistung (Aufnahme)", + "default": null, + "anyOf": [ + { + "$ref": "../com/Menge.json#" + }, + { + "type": "null" + } + ] + }, + "speicherart": { + "description": "Art des Speichers", + "default": null, + "anyOf": [ + { + "$ref": "../enum/Speicherart.json#" + }, + { + "type": "null" + } + ] + }, + "speicherkapazitaet": { + "description": "Speicherkapazität", + "default": null, + "anyOf": [ + { + "$ref": "../com/Menge.json#" + }, + { + "type": "null" + } + ] + }, + "technischeRessourceId": { + "description": "Identifikationsnummer einer technischen Ressource", + "title": "Technischeressourceid", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "technischeRessourceNutzung": { + "description": "Art und Nutzung der technischen Ressource", + "default": null, + "anyOf": [ + { + "$ref": "../enum/TechnischeRessourceNutzung.json#" + }, + { + "type": "null" + } + ] + }, + "technischeRessourceVerbrauchsart": { + "description": "Verbrauchsart der technischen Ressource", + "default": null, + "anyOf": [ + { + "$ref": "../enum/TechnischeRessourceVerbrauchsart.json#" + }, + { + "type": "null" + } + ] + }, + "vorgelagerteMesslokationId": { + "description": "Vorgelagerte Messlokation ID", + "title": "Vorgelagertemesslokationid", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "waermenutzung": { + "description": "Wärmenutzung", + "default": null, + "anyOf": [ + { + "$ref": "../enum/Waermenutzung.json#" + }, + { + "type": "null" + } + ] + }, + "zugeordneteMarktlokationId": { + "description": "Referenz auf die der technischen Ressource zugeordneten Marktlokation", + "title": "Zugeordnetemarktlokationid", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "zugeordneteSteuerbareRessourceId": { + "description": "Referenz auf die der technischen Ressource zugeordneten Steuerbaren Ressource", + "title": "Zugeordnetesteuerbareressourceid", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "zusatzAttribute": { + "title": "Zusatzattribute", + "default": null, + "anyOf": [ + { + "items": { + "$ref": "../ZusatzAttribut.json#" + }, + "type": "array" + }, + { + "type": "null" + } + ] + } + }, + "type": "object" +} diff --git a/unittests/test_data/bo4e_schemas/bo/Vertrag.json b/unittests/test_data/bo4e_schemas/bo/Vertrag.json index 5277645..d53e59a 100644 --- a/unittests/test_data/bo4e_schemas/bo/Vertrag.json +++ b/unittests/test_data/bo4e_schemas/bo/Vertrag.json @@ -1,9 +1,10 @@ { - "description": "Modell für die Abbildung von Vertragsbeziehungen;\nDas Objekt dient dazu, alle Arten von Verträgen, die in der Energiewirtschaft Verwendung finden, abzubilden.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Vertrag JSON Schema `_", + "description": "Modell für die Abbildung von Vertragsbeziehungen;\nDas Objekt dient dazu, alle Arten von Verträgen, die in der Energiewirtschaft Verwendung finden, abzubilden.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Vertrag JSON Schema `_", "title": "Vertrag", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Der Typ des Geschäftsobjektes", "default": "VERTRAG", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "beschreibung": { + "description": "Beschreibung zum Vertrag", "title": "Beschreibung", "default": null, "anyOf": [ @@ -51,6 +55,7 @@ ] }, "sparte": { + "description": "Unterscheidungsmöglichkeiten für die Sparte", "default": null, "anyOf": [ { @@ -62,6 +67,7 @@ ] }, "unterzeichnervp1": { + "description": "Unterzeichner des Vertragspartners 1", "title": "Unterzeichnervp1", "default": null, "anyOf": [ @@ -77,6 +83,7 @@ ] }, "unterzeichnervp2": { + "description": "Unterzeichner des Vertragspartners 2", "title": "Unterzeichnervp2", "default": null, "anyOf": [ @@ -92,6 +99,7 @@ ] }, "vertragsart": { + "description": "Hier ist festgelegt, um welche Art von Vertrag es sich handelt.", "default": null, "anyOf": [ { @@ -103,6 +111,7 @@ ] }, "vertragsbeginn": { + "description": "Gibt an, wann der Vertrag beginnt (inklusiv)", "title": "Vertragsbeginn", "default": null, "anyOf": [ @@ -116,6 +125,7 @@ ] }, "vertragsende": { + "description": "Gibt an, wann der Vertrag (voraussichtlich) endet oder beendet wurde (exklusiv)", "title": "Vertragsende", "default": null, "anyOf": [ @@ -129,6 +139,7 @@ ] }, "vertragskonditionen": { + "description": "Festlegungen zu Laufzeiten und Kündigungsfristen", "default": null, "anyOf": [ { @@ -140,6 +151,7 @@ ] }, "vertragsnummer": { + "description": "Eine im Verwendungskontext eindeutige Nummer für den Vertrag", "title": "Vertragsnummer", "default": null, "anyOf": [ @@ -174,6 +186,7 @@ ] }, "vertragsstatus": { + "description": "Gibt den Status des Vertrags an", "default": null, "anyOf": [ { @@ -185,6 +198,7 @@ ] }, "vertragsteile": { + "description": "Beschreibung zum Vertrag", "title": "Vertragsteile", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/bo/Zaehler.json b/unittests/test_data/bo4e_schemas/bo/Zaehler.json index fcaaaa8..cf014e3 100644 --- a/unittests/test_data/bo4e_schemas/bo/Zaehler.json +++ b/unittests/test_data/bo4e_schemas/bo/Zaehler.json @@ -1,9 +1,10 @@ { - "description": "Object containing information about a meter/\"Zaehler\".\n\n.. raw:: html\n\n \n\n.. HINT::\n `Zaehler JSON Schema `_", + "description": "Object containing information about a meter/\"Zaehler\".\n\n.. raw:: html\n\n \n\n.. HINT::\n `Zaehler JSON Schema `_", "title": "Zaehler", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Typisierung des Zählers", "default": "ZAEHLER", "anyOf": [ { @@ -27,8 +29,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -39,6 +42,7 @@ ] }, "befestigungsart": { + "description": "Besondere Spezifikation des Zählers", "default": null, "anyOf": [ { @@ -50,6 +54,7 @@ ] }, "eichungBis": { + "description": "Zählerkonstante auf dem Zähler", "title": "Eichungbis", "default": null, "anyOf": [ @@ -63,6 +68,7 @@ ] }, "geraete": { + "description": "Größe des Zählers", "title": "Geraete", "default": null, "anyOf": [ @@ -78,6 +84,7 @@ ] }, "istFernschaltbar": { + "description": "Der Hersteller des Zählers", "title": "Istfernschaltbar", "default": null, "anyOf": [ @@ -90,6 +97,7 @@ ] }, "letzteEichung": { + "description": "Bis zu diesem Datum (exklusiv) ist der Zähler geeicht.", "title": "Letzteeichung", "default": null, "anyOf": [ @@ -103,6 +111,7 @@ ] }, "messwerterfassung": { + "description": "Fernschaltung", "default": null, "anyOf": [ { @@ -114,6 +123,7 @@ ] }, "registeranzahl": { + "description": "Spezifikation bezüglich unterstützter Tarif", "default": null, "anyOf": [ { @@ -125,6 +135,7 @@ ] }, "sparte": { + "description": "Nummerierung des Zählers,vergeben durch den Messstellenbetreiber", "default": null, "anyOf": [ { @@ -136,6 +147,7 @@ ] }, "zaehlerauspraegung": { + "description": "Strom oder Gas", "default": null, "anyOf": [ { @@ -147,6 +159,7 @@ ] }, "zaehlergroesse": { + "description": "Befestigungsart", "default": null, "anyOf": [ { @@ -158,6 +171,7 @@ ] }, "zaehlerhersteller": { + "description": "Der Hersteller des Zählers", "default": null, "anyOf": [ { @@ -169,12 +183,12 @@ ] }, "zaehlerkonstante": { + "description": "Spezifikation bezüglich unterstützter Tarif", "title": "Zaehlerkonstante", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -182,6 +196,7 @@ ] }, "zaehlernummer": { + "description": "Nummerierung des Zählers,vergeben durch den Messstellenbetreiber", "title": "Zaehlernummer", "default": null, "anyOf": [ @@ -194,6 +209,7 @@ ] }, "zaehlertyp": { + "description": "Spezifikation die Richtung des Zählers betreffend", "default": null, "anyOf": [ { @@ -205,6 +221,7 @@ ] }, "zaehlertypSpezifikation": { + "description": "Messwerterfassung des Zählers", "default": null, "anyOf": [ { @@ -216,6 +233,7 @@ ] }, "zaehlwerke": { + "description": "Typisierung des Zählers", "title": "Zaehlwerke", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/bo/Zeitreihe.json b/unittests/test_data/bo4e_schemas/bo/Zeitreihe.json index a056705..7972d8a 100644 --- a/unittests/test_data/bo4e_schemas/bo/Zeitreihe.json +++ b/unittests/test_data/bo4e_schemas/bo/Zeitreihe.json @@ -1,9 +1,10 @@ { - "description": "Abbildung einer allgemeinen Zeitreihe mit einem Wertvektor.\nDie Werte können mit wahlfreier zeitlicher Distanz im Vektor abgelegt sein.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Zeitreihe JSON Schema `_", + "description": "Abbildung einer allgemeinen Zeitreihe mit einem Wertvektor.\nDie Werte können mit wahlfreier zeitlicher Distanz im Vektor abgelegt sein.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Zeitreihe JSON Schema `_", "title": "Zeitreihe", "additionalProperties": true, "properties": { "_id": { + "description": "Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer oder eine GUID)", "title": " Id", "default": null, "anyOf": [ @@ -16,6 +17,7 @@ ] }, "_typ": { + "description": "Bezeichnung für die Zeitreihe", "default": "ZEITREIHE", "anyOf": [ { @@ -27,6 +29,7 @@ ] }, "beschreibung": { + "description": "Beschreibt die Verwendung der Zeitreihe", "title": "Beschreibung", "default": null, "anyOf": [ @@ -39,6 +42,7 @@ ] }, "bezeichnung": { + "description": "Bezeichnung für die Zeitreihe", "title": "Bezeichnung", "default": null, "anyOf": [ @@ -51,6 +55,7 @@ ] }, "einheit": { + "description": "Alle Werte in der Tabelle haben die Einheit, die hier angegeben ist", "default": null, "anyOf": [ { @@ -62,6 +67,7 @@ ] }, "medium": { + "description": "Medium, das gemessen wurde (z.B. Wasser, Dampf, Strom, Gas)", "default": null, "anyOf": [ { @@ -73,6 +79,7 @@ ] }, "messart": { + "description": "Beschreibt die Art der Messung (z.B. aktueller Wert, mittlerer Wert, maximaler Wert)", "default": null, "anyOf": [ { @@ -84,6 +91,7 @@ ] }, "messgroesse": { + "description": "Beschreibt, was gemessen wurde (z.B. Strom, Spannung, Wirkleistung, Scheinleistung)", "default": null, "anyOf": [ { @@ -95,6 +103,7 @@ ] }, "version": { + "description": "Version der Zeitreihe", "title": "Version", "default": null, "anyOf": [ @@ -107,6 +116,7 @@ ] }, "werte": { + "description": "Hier liegen jeweils die Werte", "title": "Werte", "default": null, "anyOf": [ @@ -122,6 +132,7 @@ ] }, "wertherkunft": { + "description": "Kennzeichnung, wie die Werte entstanden sind, z.B. durch Messung", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/Adresse.json b/unittests/test_data/bo4e_schemas/com/Adresse.json index 02aa8e9..7bf46f3 100644 --- a/unittests/test_data/bo4e_schemas/com/Adresse.json +++ b/unittests/test_data/bo4e_schemas/com/Adresse.json @@ -1,9 +1,10 @@ { - "description": "Contains an address that can be used for most purposes.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Adresse JSON Schema `_", + "description": "Contains an address that can be used for most purposes.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Adresse JSON Schema `_", "title": "Adresse", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "adresszusatz": { + "description": "Zusatzhinweis zum Auffinden der Adresse, z.B. \"3. Stock linke Wohnung\"", "title": "Adresszusatz", "default": null, "anyOf": [ @@ -40,6 +43,7 @@ ] }, "coErgaenzung": { + "description": "Im Falle einer c/o-Adresse steht in diesem Attribut die Anrede. Z.B. \"c/o Veronica Hauptmieterin\"", "title": "Coergaenzung", "default": null, "anyOf": [ @@ -52,6 +56,7 @@ ] }, "hausnummer": { + "description": "Hausnummer inkl. Zusatz; z.B. \"3\", \"4a\"", "title": "Hausnummer", "default": null, "anyOf": [ @@ -64,6 +69,7 @@ ] }, "landescode": { + "description": "Offizieller ISO-Landescode", "default": "DE", "anyOf": [ { @@ -75,6 +81,7 @@ ] }, "ort": { + "description": "Bezeichnung der Stadt; z.B. \"Hückelhoven\"", "title": "Ort", "default": null, "anyOf": [ @@ -87,6 +94,7 @@ ] }, "ortsteil": { + "description": "Bezeichnung des Ortsteils; z.B. \"Mitte\"", "title": "Ortsteil", "default": null, "anyOf": [ @@ -99,6 +107,7 @@ ] }, "postfach": { + "description": "Im Falle einer Postfachadresse das Postfach; Damit werden Straße und Hausnummer nicht berücksichtigt", "title": "Postfach", "default": null, "anyOf": [ @@ -111,6 +120,7 @@ ] }, "postleitzahl": { + "description": "Die Postleitzahl; z.B: \"41836\"", "title": "Postleitzahl", "default": null, "anyOf": [ @@ -123,6 +133,7 @@ ] }, "strasse": { + "description": "Bezeichnung der Straße; z.B. \"Weserstraße\"", "title": "Strasse", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/Angebotsposition.json b/unittests/test_data/bo4e_schemas/com/Angebotsposition.json index 317730b..6fb5165 100644 --- a/unittests/test_data/bo4e_schemas/com/Angebotsposition.json +++ b/unittests/test_data/bo4e_schemas/com/Angebotsposition.json @@ -1,9 +1,10 @@ { - "description": "Unterhalb von Angebotsteilen sind die Angebotspositionen eingebunden.\nHier werden die angebotenen Bestandteile einzeln aufgeführt. Beispiel:\nPositionsmenge: 4000 kWh\nPositionspreis: 24,56 ct/kWh\nPositionskosten: 982,40 EUR\n\n.. raw:: html\n\n \n\n.. HINT::\n `Angebotsposition JSON Schema `_", + "description": "Unterhalb von Angebotsteilen sind die Angebotspositionen eingebunden.\nHier werden die angebotenen Bestandteile einzeln aufgeführt. Beispiel:\nPositionsmenge: 4000 kWh\nPositionspreis: 24,56 ct/kWh\nPositionskosten: 982,40 EUR\n\n.. raw:: html\n\n \n\n.. HINT::\n `Angebotsposition JSON Schema `_", "title": "Angebotsposition", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "positionsbezeichnung": { + "description": "Bezeichnung der jeweiligen Position des Angebotsteils", "title": "Positionsbezeichnung", "default": null, "anyOf": [ @@ -40,6 +43,7 @@ ] }, "positionskosten": { + "description": "Kosten (positionspreis * positionsmenge) für diese Angebotsposition", "default": null, "anyOf": [ { @@ -51,6 +55,7 @@ ] }, "positionsmenge": { + "description": "Menge des angebotenen Artikels (z.B. Wirkarbeit in kWh), in dieser Angebotsposition", "default": null, "anyOf": [ { @@ -62,6 +67,7 @@ ] }, "positionspreis": { + "description": "Preis pro Einheit/Stückpreis des angebotenen Artikels.", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/Angebotsteil.json b/unittests/test_data/bo4e_schemas/com/Angebotsteil.json index 722fa6e..c5f314e 100644 --- a/unittests/test_data/bo4e_schemas/com/Angebotsteil.json +++ b/unittests/test_data/bo4e_schemas/com/Angebotsteil.json @@ -1,9 +1,10 @@ { - "description": "Mit dieser Komponente wird ein Teil einer Angebotsvariante abgebildet.\nHier werden alle Angebotspositionen aggregiert.\nAngebotsteile werden im einfachsten Fall für eine Marktlokation oder Lieferstellenadresse erzeugt.\nHier werden die Mengen und Gesamtkosten aller Angebotspositionen zusammengefasst.\nEine Variante besteht mindestens aus einem Angebotsteil.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Angebotsteil JSON Schema `_", + "description": "Mit dieser Komponente wird ein Teil einer Angebotsvariante abgebildet.\nHier werden alle Angebotspositionen aggregiert.\nAngebotsteile werden im einfachsten Fall für eine Marktlokation oder Lieferstellenadresse erzeugt.\nHier werden die Mengen und Gesamtkosten aller Angebotspositionen zusammengefasst.\nEine Variante besteht mindestens aus einem Angebotsteil.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Angebotsteil JSON Schema `_", "title": "Angebotsteil", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "anfrageSubreferenz": { + "description": "Identifizierung eines Subkapitels einer Anfrage, beispielsweise das Los einer Ausschreibung", "title": "Anfragesubreferenz", "default": null, "anyOf": [ @@ -40,6 +43,7 @@ ] }, "gesamtkostenangebotsteil": { + "description": "Summe der Jahresenergiekosten aller in diesem Angebotsteil enthaltenen Lieferstellen", "default": null, "anyOf": [ { @@ -51,6 +55,7 @@ ] }, "gesamtmengeangebotsteil": { + "description": "Summe der Verbräuche aller in diesem Angebotsteil eingeschlossenen Lieferstellen", "default": null, "anyOf": [ { @@ -62,6 +67,7 @@ ] }, "lieferstellenangebotsteil": { + "description": "Marktlokationen, für die dieses Angebotsteil gilt, falls vorhanden.\nDurch die Marktlokation ist auch die Lieferadresse festgelegt", "title": "Lieferstellenangebotsteil", "default": null, "anyOf": [ @@ -77,6 +83,7 @@ ] }, "lieferzeitraum": { + "description": "Hier kann der Belieferungszeitraum angegeben werden, für den dieser Angebotsteil gilt", "default": null, "anyOf": [ { @@ -88,6 +95,7 @@ ] }, "positionen": { + "description": "Einzelne Positionen, die zu diesem Angebotsteil gehören", "title": "Positionen", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/Angebotsvariante.json b/unittests/test_data/bo4e_schemas/com/Angebotsvariante.json index 74a3fcb..42ee205 100644 --- a/unittests/test_data/bo4e_schemas/com/Angebotsvariante.json +++ b/unittests/test_data/bo4e_schemas/com/Angebotsvariante.json @@ -1,9 +1,10 @@ { - "description": "Führt die verschiedenen Ausprägungen der Angebotsberechnung auf\n\n.. raw:: html\n\n \n\n.. HINT::\n `Angebotsvariante JSON Schema `_", + "description": "Führt die verschiedenen Ausprägungen der Angebotsberechnung auf\n\n.. raw:: html\n\n \n\n.. HINT::\n `Angebotsvariante JSON Schema `_", "title": "Angebotsvariante", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "angebotsstatus": { + "description": "Gibt den Status eines Angebotes an.", "default": null, "anyOf": [ { @@ -39,6 +42,7 @@ ] }, "bindefrist": { + "description": "Bis zu diesem Zeitpunkt gilt die Angebotsvariante", "title": "Bindefrist", "default": null, "anyOf": [ @@ -52,6 +56,7 @@ ] }, "erstellungsdatum": { + "description": "Datum der Erstellung der Angebotsvariante", "title": "Erstellungsdatum", "default": null, "anyOf": [ @@ -65,6 +70,7 @@ ] }, "gesamtkosten": { + "description": "Aufsummierte Kosten aller Angebotsteile", "default": null, "anyOf": [ { @@ -76,6 +82,7 @@ ] }, "gesamtmenge": { + "description": "Aufsummierte Wirkarbeitsmenge aller Angebotsteile", "default": null, "anyOf": [ { @@ -87,6 +94,7 @@ ] }, "teile": { + "description": "Angebotsteile werden im einfachsten Fall für eine Marktlokation oder Lieferstellenadresse erzeugt.\nHier werden die Mengen und Gesamtkosten aller Angebotspositionen zusammengefasst.\nEine Variante besteht mindestens aus einem Angebotsteil.", "title": "Teile", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/AufAbschlag.json b/unittests/test_data/bo4e_schemas/com/AufAbschlag.json index a74947f..ed14663 100644 --- a/unittests/test_data/bo4e_schemas/com/AufAbschlag.json +++ b/unittests/test_data/bo4e_schemas/com/AufAbschlag.json @@ -1,9 +1,10 @@ { - "description": "Modell für die preiserhöhenden (Aufschlag) bzw. preisvermindernden (Abschlag) Zusatzvereinbarungen,\ndie individuell zu einem neuen oder bestehenden Liefervertrag abgeschlossen wurden.\n\n.. raw:: html\n\n \n\n.. HINT::\n `AufAbschlag JSON Schema `_", + "description": "Modell für die preiserhöhenden (Aufschlag) bzw. preisvermindernden (Abschlag) Zusatzvereinbarungen,\ndie individuell zu einem neuen oder bestehenden Liefervertrag abgeschlossen wurden.\n\n.. raw:: html\n\n \n\n.. HINT::\n `AufAbschlag JSON Schema `_", "title": "AufAbschlag", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "aufAbschlagstyp": { + "description": "Typ des Aufabschlages (z.B. absolut oder prozentual).", "default": null, "anyOf": [ { @@ -39,6 +42,7 @@ ] }, "aufAbschlagsziel": { + "description": "Diesem Preis oder den Kosten ist der Auf/Abschlag zugeordnet. Z.B. Arbeitspreis, Gesamtpreis etc..", "default": null, "anyOf": [ { @@ -50,6 +54,7 @@ ] }, "beschreibung": { + "description": "Beschreibung zum Auf-/Abschlag", "title": "Beschreibung", "default": null, "anyOf": [ @@ -62,6 +67,7 @@ ] }, "bezeichnung": { + "description": "Bezeichnung des Auf-/Abschlags", "title": "Bezeichnung", "default": null, "anyOf": [ @@ -74,6 +80,7 @@ ] }, "einheit": { + "description": "Gibt an in welcher Währungseinheit der Auf/Abschlag berechnet wird. Euro oder Ct..\n(Nur im Falle absoluter Aufschlagstypen). ", "default": null, "anyOf": [ { @@ -85,6 +92,7 @@ ] }, "gueltigkeitszeitraum": { + "description": "Internetseite, auf der die Informationen zum Auf-/Abschlag veröffentlicht sind.", "default": null, "anyOf": [ { @@ -96,6 +104,7 @@ ] }, "staffeln": { + "description": "Werte für die gestaffelten Auf/Abschläge.", "title": "Staffeln", "default": null, "anyOf": [ @@ -111,6 +120,7 @@ ] }, "website": { + "description": "Internetseite, auf der die Informationen zum Auf-/Abschlag veröffentlicht sind.", "title": "Website", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/AufAbschlagProOrt.json b/unittests/test_data/bo4e_schemas/com/AufAbschlagProOrt.json index 2d5dbad..575b244 100644 --- a/unittests/test_data/bo4e_schemas/com/AufAbschlagProOrt.json +++ b/unittests/test_data/bo4e_schemas/com/AufAbschlagProOrt.json @@ -1,9 +1,10 @@ { - "description": "Mit dieser Komponente können Auf- und Abschläge verschiedener Typen im Zusammenhang\nmit örtlichen Gültigkeiten abgebildet werden.\n\n.. raw:: html\n\n \n\n.. HINT::\n `AufAbschlagProOrt JSON Schema `_", + "description": "Mit dieser Komponente können Auf- und Abschläge verschiedener Typen im Zusammenhang\nmit örtlichen Gültigkeiten abgebildet werden.\n\n.. raw:: html\n\n \n\n.. HINT::\n `AufAbschlagProOrt JSON Schema `_", "title": "AufAbschlagProOrt", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "netznr": { + "description": "Die ene't-Netznummer des Netzes in dem der Aufschlag gilt.", "title": "Netznr", "default": null, "anyOf": [ @@ -40,6 +43,7 @@ ] }, "ort": { + "description": "Der Ort für den der Aufschlag gilt.", "title": "Ort", "default": null, "anyOf": [ @@ -52,6 +56,7 @@ ] }, "postleitzahl": { + "description": "Die Postleitzahl des Ortes für den der Aufschlag gilt.", "title": "Postleitzahl", "default": null, "anyOf": [ @@ -64,6 +69,7 @@ ] }, "staffeln": { + "description": "Werte für die gestaffelten Auf/Abschläge mit regionaler Eingrenzung.", "title": "Staffeln", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/AufAbschlagRegional.json b/unittests/test_data/bo4e_schemas/com/AufAbschlagRegional.json index 55f93fa..578ee09 100644 --- a/unittests/test_data/bo4e_schemas/com/AufAbschlagRegional.json +++ b/unittests/test_data/bo4e_schemas/com/AufAbschlagRegional.json @@ -1,9 +1,10 @@ { - "description": "Mit dieser Komponente können Auf- und Abschläge verschiedener Typen\nim Zusammenhang mit regionalen Gültigkeiten abgebildet werden.\nHier sind auch die Auswirkungen auf verschiedene Tarifparameter modelliert,\ndie sich durch die Auswahl eines Auf- oder Abschlags ergeben.\n\n.. raw:: html\n\n \n\n.. HINT::\n `AufAbschlagRegional JSON Schema `_", + "description": "Mit dieser Komponente können Auf- und Abschläge verschiedener Typen\nim Zusammenhang mit regionalen Gültigkeiten abgebildet werden.\nHier sind auch die Auswirkungen auf verschiedene Tarifparameter modelliert,\ndie sich durch die Auswahl eines Auf- oder Abschlags ergeben.\n\n.. raw:: html\n\n \n\n.. HINT::\n `AufAbschlagRegional JSON Schema `_", "title": "AufAbschlagRegional", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "aufAbschlagstyp": { + "description": "Typ des Aufabschlages (z.B. absolut oder prozentual)", "default": null, "anyOf": [ { @@ -39,6 +42,7 @@ ] }, "aufAbschlagsziel": { + "description": "Diesem Preis oder den Kosten ist der Auf/Abschlag zugeordnet. Z.B. Arbeitspreis, Gesamtpreis etc.", "default": null, "anyOf": [ { @@ -50,6 +54,7 @@ ] }, "beschreibung": { + "description": "Beschreibung zum Auf-/Abschlag", "title": "Beschreibung", "default": null, "anyOf": [ @@ -62,6 +67,7 @@ ] }, "betraege": { + "description": "Werte für die gestaffelten Auf/Abschläge mit regionaler Eingrenzung", "title": "Betraege", "default": null, "anyOf": [ @@ -77,6 +83,7 @@ ] }, "bezeichnung": { + "description": "Bezeichnung des Auf-/Abschlags", "title": "Bezeichnung", "default": null, "anyOf": [ @@ -89,6 +96,7 @@ ] }, "einheit": { + "description": "Gibt an in welcher Währungseinheit der Auf/Abschlag berechnet wird. Euro oder Ct.", "default": null, "anyOf": [ { @@ -100,6 +108,7 @@ ] }, "einschraenkungsaenderung": { + "description": "Änderungen in den Einschränkungen zum Tarif. Falls in dieser Komponenten angegeben,\nwerden die Tarifparameter hiermit überschrieben.", "default": null, "anyOf": [ { @@ -111,6 +120,7 @@ ] }, "energiemixaenderung": { + "description": "Der Energiemix kann sich durch einen AufAbschlag ändern (z.B. zwei Cent Aufschlag für Ökostrom:\nSollte dies der Fall sein, wird hier die neue Zusammensetzung des Energiemix angegeben.", "default": null, "anyOf": [ { @@ -122,6 +132,7 @@ ] }, "garantieaenderung": { + "description": "Änderungen in den Garantievereinbarungen. Falls in dieser Komponenten angegeben,\nwerden die Tarifparameter hiermit überschrieben.", "default": null, "anyOf": [ { @@ -133,6 +144,7 @@ ] }, "gueltigkeitszeitraum": { + "description": "Zeitraum, in dem der Abschlag zur Anwendung kommen kann", "default": null, "anyOf": [ { @@ -144,6 +156,7 @@ ] }, "tarifnamensaenderungen": { + "description": "Durch die Anwendung des Auf/Abschlags kann eine Änderung des Tarifnamens auftreten.", "title": "Tarifnamensaenderungen", "default": null, "anyOf": [ @@ -156,6 +169,7 @@ ] }, "vertagskonditionsaenderung": { + "description": "Änderungen in den Vertragskonditionen. Falls in dieser Komponenten angegeben,\nwerden die Tarifparameter hiermit überschrieben.", "default": null, "anyOf": [ { @@ -167,6 +181,7 @@ ] }, "voraussetzungen": { + "description": "Voraussetzungen, die erfüllt sein müssen, damit dieser AufAbschlag zur Anwendung kommen kann", "title": "Voraussetzungen", "default": null, "anyOf": [ @@ -182,6 +197,7 @@ ] }, "website": { + "description": "Internetseite, auf der die Informationen zum Auf-/Abschlag veröffentlicht sind", "title": "Website", "default": null, "anyOf": [ @@ -209,6 +225,7 @@ ] }, "zusatzprodukte": { + "description": "Zusatzprodukte, die nur in Kombination mit diesem AufAbschlag erhältlich sind", "title": "Zusatzprodukte", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/AufAbschlagstaffelProOrt.json b/unittests/test_data/bo4e_schemas/com/AufAbschlagstaffelProOrt.json index dead996..d0afdf8 100644 --- a/unittests/test_data/bo4e_schemas/com/AufAbschlagstaffelProOrt.json +++ b/unittests/test_data/bo4e_schemas/com/AufAbschlagstaffelProOrt.json @@ -1,9 +1,10 @@ { - "description": "Gibt den Wert eines Auf- oder Abschlags und dessen Staffelgrenzen an\n\n.. raw:: html\n\n \n\n.. HINT::\n `AufAbschlagstaffelProOrt JSON Schema `_", + "description": "Gibt den Wert eines Auf- oder Abschlags und dessen Staffelgrenzen an\n\n.. raw:: html\n\n \n\n.. HINT::\n `AufAbschlagstaffelProOrt JSON Schema `_", "title": "AufAbschlagstaffelProOrt", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,12 +30,12 @@ ] }, "staffelgrenzeBis": { + "description": "Oberer Wert, bis zu dem die Staffel gilt.", "title": "Staffelgrenzebis", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -41,12 +43,12 @@ ] }, "staffelgrenzeVon": { + "description": "Unterer Wert, ab dem die Staffel gilt.", "title": "Staffelgrenzevon", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -54,12 +56,12 @@ ] }, "wert": { + "description": "Der Wert für den Auf- oder Abschlag.", "title": "Wert", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" diff --git a/unittests/test_data/bo4e_schemas/com/Ausschreibungsdetail.json b/unittests/test_data/bo4e_schemas/com/Ausschreibungsdetail.json index cad5f38..a65987f 100644 --- a/unittests/test_data/bo4e_schemas/com/Ausschreibungsdetail.json +++ b/unittests/test_data/bo4e_schemas/com/Ausschreibungsdetail.json @@ -1,9 +1,10 @@ { - "description": "Die Komponente Ausschreibungsdetail wird verwendet um die Informationen zu einer Abnahmestelle innerhalb eines\nAusschreibungsloses abzubilden.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Ausschreibungsdetail JSON Schema `_", + "description": "Die Komponente Ausschreibungsdetail wird verwendet um die Informationen zu einer Abnahmestelle innerhalb eines\nAusschreibungsloses abzubilden.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Ausschreibungsdetail JSON Schema `_", "title": "Ausschreibungsdetail", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "istLastgangVorhanden": { + "description": "Zeigt an, ob es zu der Marktlokation einen Lastgang gibt.\nFalls ja, kann dieser abgerufen werden und daraus die Verbrauchswerte ermittelt werden", "title": "Istlastgangvorhanden", "default": null, "anyOf": [ @@ -40,6 +43,7 @@ ] }, "kunde": { + "description": "Bezeichnung des Kunden, der die Marktlokation nutzt", "title": "Kunde", "default": null, "anyOf": [ @@ -52,6 +56,7 @@ ] }, "lieferzeitraum": { + "description": "Angefragter Zeitraum für die ausgeschriebene Belieferung", "default": null, "anyOf": [ { @@ -63,6 +68,7 @@ ] }, "marktlokationsId": { + "description": "Identifikation einer ausgeschriebenen Marktlokation", "title": "Marktlokationsid", "default": null, "anyOf": [ @@ -75,6 +81,7 @@ ] }, "marktlokationsadresse": { + "description": "Die Adresse an der die Marktlokation sich befindet", "default": null, "anyOf": [ { @@ -86,6 +93,7 @@ ] }, "marktlokationsbezeichnung": { + "description": "Bezeichnung für die Lokation, z.B. 'Zentraler Einkauf, Hamburg'", "title": "Marktlokationsbezeichnung", "default": null, "anyOf": [ @@ -98,6 +106,7 @@ ] }, "netzbetreiber": { + "description": "Bezeichnung des zuständigen Netzbetreibers, z.B. 'Stromnetz Hamburg GmbH'", "title": "Netzbetreiber", "default": null, "anyOf": [ @@ -110,6 +119,7 @@ ] }, "netzebeneLieferung": { + "description": "In der angegebenen Netzebene wird die Marktlokation versorgt, z.B. MSP für Mittelspannung", "title": "Netzebenelieferung", "default": null, "anyOf": [ @@ -122,6 +132,7 @@ ] }, "netzebeneMessung": { + "description": "In der angegebenen Netzebene wird die Lokation gemessen, z.B. NSP für Niederspannung", "title": "Netzebenemessung", "default": null, "anyOf": [ @@ -134,6 +145,7 @@ ] }, "prognoseArbeitLieferzeitraum": { + "description": "Ein Prognosewert für die Arbeit innerhalb des angefragten Lieferzeitraums der ausgeschriebenen Lokation", "default": null, "anyOf": [ { @@ -145,6 +157,7 @@ ] }, "prognoseJahresarbeit": { + "description": "Prognosewert für die Jahresarbeit der ausgeschriebenen Lokation", "default": null, "anyOf": [ { @@ -156,6 +169,7 @@ ] }, "prognoseLeistung": { + "description": "Prognosewert für die abgenommene maximale Leistung der ausgeschriebenen Lokation", "default": null, "anyOf": [ { @@ -167,6 +181,7 @@ ] }, "rechnungsadresse": { + "description": "Die (evtl. abweichende) Rechnungsadresse", "default": null, "anyOf": [ { @@ -178,6 +193,7 @@ ] }, "zaehlernummer": { + "description": "Die Bezeichnung des Zählers an der Marktlokation", "title": "Zaehlernummer", "default": null, "anyOf": [ @@ -190,6 +206,7 @@ ] }, "zaehlertechnik": { + "description": "Spezifikation, um welche Zählertechnik es sich im vorliegenden Fall handelt, z.B. Leistungsmessung", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/Ausschreibungslos.json b/unittests/test_data/bo4e_schemas/com/Ausschreibungslos.json index 2829dd5..9adfec4 100644 --- a/unittests/test_data/bo4e_schemas/com/Ausschreibungslos.json +++ b/unittests/test_data/bo4e_schemas/com/Ausschreibungslos.json @@ -1,9 +1,10 @@ { - "description": "Eine Komponente zur Abbildung einzelner Lose einer Ausschreibung\n\n.. raw:: html\n\n \n\n.. HINT::\n `Ausschreibungslos JSON Schema `_", + "description": "Eine Komponente zur Abbildung einzelner Lose einer Ausschreibung\n\n.. raw:: html\n\n \n\n.. HINT::\n `Ausschreibungslos JSON Schema `_", "title": "Ausschreibungslos", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "anzahlLieferstellen": { + "description": "Anzahl der Lieferstellen in dieser Ausschreibung", "title": "Anzahllieferstellen", "default": null, "anyOf": [ @@ -40,6 +43,7 @@ ] }, "bemerkung": { + "description": "Bemerkung des Kunden zum Los", "title": "Bemerkung", "default": null, "anyOf": [ @@ -52,6 +56,7 @@ ] }, "betreutDurch": { + "description": "Name des Lizenzpartners", "title": "Betreutdurch", "default": null, "anyOf": [ @@ -64,6 +69,7 @@ ] }, "bezeichnung": { + "description": "Bezeichnung der Ausschreibung", "title": "Bezeichnung", "default": null, "anyOf": [ @@ -76,6 +82,7 @@ ] }, "energieart": { + "description": "Unterscheidungsmöglichkeiten für die Sparte", "default": null, "anyOf": [ { @@ -87,6 +94,7 @@ ] }, "gesamtMenge": { + "description": "Gibt den Gesamtjahresverbrauch (z.B. in kWh) aller in diesem Los enthaltenen Lieferstellen an", "default": null, "anyOf": [ { @@ -98,6 +106,7 @@ ] }, "lieferstellen": { + "description": "Die ausgeschriebenen Lieferstellen", "title": "Lieferstellen", "default": null, "anyOf": [ @@ -113,6 +122,7 @@ ] }, "lieferzeitraum": { + "description": "Zeitraum, für den die in diesem Los enthaltenen Lieferstellen beliefert werden sollen", "default": null, "anyOf": [ { @@ -124,6 +134,7 @@ ] }, "losnummer": { + "description": "Laufende Nummer des Loses", "title": "Losnummer", "default": null, "anyOf": [ @@ -136,6 +147,7 @@ ] }, "preismodell": { + "description": "Bezeichnung der Preismodelle in Ausschreibungen für die Energielieferung", "default": null, "anyOf": [ { @@ -147,6 +159,7 @@ ] }, "wiederholungsintervall": { + "description": "In welchem Intervall die Angebotsabgabe wiederholt werden darf.\nAngabe nur gesetzt für die 2. Phase bei öffentlich-rechtlichen Ausschreibungen", "default": null, "anyOf": [ { @@ -158,6 +171,7 @@ ] }, "wunschKuendingungsfrist": { + "description": "Kundenwunsch zur Kündigungsfrist in der Ausschreibung", "default": null, "anyOf": [ { @@ -169,6 +183,7 @@ ] }, "wunschMaximalmenge": { + "description": "Maximalmenge Toleranzband (kWh, %)", "default": null, "anyOf": [ { @@ -180,6 +195,7 @@ ] }, "wunschMindestmenge": { + "description": "Mindesmenge Toleranzband (kWh, %)", "default": null, "anyOf": [ { @@ -191,6 +207,7 @@ ] }, "wunschRechnungslegung": { + "description": "Aufzählung der Möglichkeiten zur Rechnungslegung in Ausschreibungen", "default": null, "anyOf": [ { @@ -202,6 +219,7 @@ ] }, "wunschVertragsform": { + "description": "Aufzählung der Möglichkeiten zu Vertragsformen in Ausschreibungen", "default": null, "anyOf": [ { @@ -213,6 +231,7 @@ ] }, "wunschZahlungsziel": { + "description": "Kundenwunsch zum Zahlungsziel in der Ausschreibung", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/Betrag.json b/unittests/test_data/bo4e_schemas/com/Betrag.json index fdff217..719a1fc 100644 --- a/unittests/test_data/bo4e_schemas/com/Betrag.json +++ b/unittests/test_data/bo4e_schemas/com/Betrag.json @@ -1,9 +1,10 @@ { - "description": "Die Komponente wird dazu verwendet, Summenbeträge (beispielsweise in Angeboten und Rechnungen) als Geldbeträge\nabzubilden. Die Einheit ist dabei immer die Hauptwährung also Euro, Dollar etc…\n\n.. raw:: html\n\n \n\n.. HINT::\n `Betrag JSON Schema `_", + "description": "Die Komponente wird dazu verwendet, Summenbeträge (beispielsweise in Angeboten und Rechnungen) als Geldbeträge\nabzubilden. Die Einheit ist dabei immer die Hauptwährung also Euro, Dollar etc…\n\n.. raw:: html\n\n \n\n.. HINT::\n `Betrag JSON Schema `_", "title": "Betrag", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "waehrung": { + "description": "Gibt den Betrag des Preises an.", "default": null, "anyOf": [ { @@ -39,12 +42,12 @@ ] }, "wert": { + "description": "Gibt den Betrag des Preises an.", "title": "Wert", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" diff --git a/unittests/test_data/bo4e_schemas/com/COM.json b/unittests/test_data/bo4e_schemas/com/COM.json deleted file mode 100644 index 8dc4c74..0000000 --- a/unittests/test_data/bo4e_schemas/com/COM.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "description": "base class for all components\n\n.. raw:: html\n\n \n\n.. HINT::\n `COM JSON Schema `_", - "title": "COM", - "additionalProperties": true, - "properties": { - "_id": { - "title": " Id", - "default": null, - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "_version": { - "title": " Version", - "default": "v202401.0.1", - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "zusatzAttribute": { - "title": "Zusatzattribute", - "default": null, - "anyOf": [ - { - "items": { - "$ref": "../ZusatzAttribut.json#" - }, - "type": "array" - }, - { - "type": "null" - } - ] - } - }, - "type": "object" -} diff --git a/unittests/test_data/bo4e_schemas/com/Dienstleistung.json b/unittests/test_data/bo4e_schemas/com/Dienstleistung.json index 5eca324..40402f6 100644 --- a/unittests/test_data/bo4e_schemas/com/Dienstleistung.json +++ b/unittests/test_data/bo4e_schemas/com/Dienstleistung.json @@ -1,9 +1,10 @@ { - "description": "Abbildung einer abrechenbaren Dienstleistung.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Dienstleistung JSON Schema `_", + "description": "Abbildung einer abrechenbaren Dienstleistung.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Dienstleistung JSON Schema `_", "title": "Dienstleistung", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "bezeichnung": { + "description": "Bezeichnung der Dienstleistung", "title": "Bezeichnung", "default": null, "anyOf": [ @@ -40,6 +43,7 @@ ] }, "dienstleistungstyp": { + "description": "Kennzeichnung der Dienstleistung", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/Energieherkunft.json b/unittests/test_data/bo4e_schemas/com/Energieherkunft.json index 266d7f3..25d6535 100644 --- a/unittests/test_data/bo4e_schemas/com/Energieherkunft.json +++ b/unittests/test_data/bo4e_schemas/com/Energieherkunft.json @@ -1,9 +1,10 @@ { - "description": "Abbildung einer Energieherkunft\n\n.. raw:: html\n\n \n\n.. HINT::\n `Energieherkunft JSON Schema `_", + "description": "Abbildung einer Energieherkunft\n\n.. raw:: html\n\n \n\n.. HINT::\n `Energieherkunft JSON Schema `_", "title": "Energieherkunft", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,12 +30,12 @@ ] }, "anteilProzent": { + "description": "Prozentualer Anteil der jeweiligen Erzeugungsart.", "title": "Anteilprozent", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -41,6 +43,7 @@ ] }, "erzeugungsart": { + "description": "Art der Erzeugung der Energie.", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/Energiemix.json b/unittests/test_data/bo4e_schemas/com/Energiemix.json index 4ea6d4f..e5dd221 100644 --- a/unittests/test_data/bo4e_schemas/com/Energiemix.json +++ b/unittests/test_data/bo4e_schemas/com/Energiemix.json @@ -1,9 +1,10 @@ { - "description": "Zusammensetzung der gelieferten Energie aus den verschiedenen Primärenergieformen.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Energiemix JSON Schema `_", + "description": "Zusammensetzung der gelieferten Energie aus den verschiedenen Primärenergieformen.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Energiemix JSON Schema `_", "title": "Energiemix", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "anteil": { + "description": "Anteile der jeweiligen Erzeugungsart", "title": "Anteil", "default": null, "anyOf": [ @@ -43,12 +46,12 @@ ] }, "atommuell": { + "description": "Höhe des erzeugten Atommülls in g/kWh", "title": "Atommuell", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -56,6 +59,7 @@ ] }, "bemerkung": { + "description": "Bemerkung zum Energiemix", "title": "Bemerkung", "default": null, "anyOf": [ @@ -68,6 +72,7 @@ ] }, "bezeichnung": { + "description": "Bezeichnung des Energiemix", "title": "Bezeichnung", "default": null, "anyOf": [ @@ -80,12 +85,12 @@ ] }, "co2Emission": { + "description": "Höhe des erzeugten CO2-Ausstosses in g/kWh", "title": "Co2Emission", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -93,6 +98,7 @@ ] }, "energieart": { + "description": "Strom oder Gas etc.", "default": null, "anyOf": [ { @@ -104,6 +110,7 @@ ] }, "energiemixnummer": { + "description": "Eindeutige Nummer zur Identifizierung des Energiemixes", "title": "Energiemixnummer", "default": null, "anyOf": [ @@ -116,6 +123,7 @@ ] }, "gueltigkeitsjahr": { + "description": "Jahr, für das der Energiemix gilt", "title": "Gueltigkeitsjahr", "default": null, "anyOf": [ @@ -128,6 +136,7 @@ ] }, "istInOekoTopTen": { + "description": "Kennzeichen, ob der Versorger zu den Öko Top Ten gehört", "title": "Istinoekotopten", "default": null, "anyOf": [ @@ -140,6 +149,7 @@ ] }, "oekolabel": { + "description": "Ökolabel für den Energiemix", "title": "Oekolabel", "default": null, "anyOf": [ @@ -155,6 +165,7 @@ ] }, "oekozertifikate": { + "description": "Zertifikate für den Energiemix", "title": "Oekozertifikate", "default": null, "anyOf": [ @@ -170,6 +181,7 @@ ] }, "website": { + "description": "Internetseite, auf der die Strommixdaten veröffentlicht sind", "title": "Website", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/Fremdkostenblock.json b/unittests/test_data/bo4e_schemas/com/Fremdkostenblock.json index 143cfff..c9b83b4 100644 --- a/unittests/test_data/bo4e_schemas/com/Fremdkostenblock.json +++ b/unittests/test_data/bo4e_schemas/com/Fremdkostenblock.json @@ -1,9 +1,10 @@ { - "description": "Komponente zur Abbildung eines Kostenblocks in den Fremdkosten\n\n.. raw:: html\n\n \n\n.. HINT::\n `Fremdkostenblock JSON Schema `_", + "description": "Komponente zur Abbildung eines Kostenblocks in den Fremdkosten\n\n.. raw:: html\n\n \n\n.. HINT::\n `Fremdkostenblock JSON Schema `_", "title": "Fremdkostenblock", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "kostenblockbezeichnung": { + "description": "Bezeichnung für einen Kostenblock. Z.B. Netzkosten, Messkosten, Umlagen, etc.", "title": "Kostenblockbezeichnung", "default": null, "anyOf": [ @@ -40,6 +43,7 @@ ] }, "kostenpositionen": { + "description": "Hier sind die Details zu einer Kostenposition aufgeführt. Z.B.:\nAlliander Netz Heinsberg GmbH, 2018-02-01, 2019-01-01, Arbeitspreis HT, 3.660 kWh,\n5,8200 ct/kWh, 213,01 €", "title": "Kostenpositionen", "default": null, "anyOf": [ @@ -55,6 +59,7 @@ ] }, "summeKostenblock": { + "description": "Die Summe aller Kostenpositionen dieses Blocks", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/Fremdkostenposition.json b/unittests/test_data/bo4e_schemas/com/Fremdkostenposition.json index ea3de9f..118098c 100644 --- a/unittests/test_data/bo4e_schemas/com/Fremdkostenposition.json +++ b/unittests/test_data/bo4e_schemas/com/Fremdkostenposition.json @@ -1,9 +1,10 @@ { - "description": "Eine Kostenposition im Bereich der Fremdkosten\n\n.. raw:: html\n\n \n\n.. HINT::\n `Fremdkostenposition JSON Schema `_", + "description": "Eine Kostenposition im Bereich der Fremdkosten\n\n.. raw:: html\n\n \n\n.. HINT::\n `Fremdkostenposition JSON Schema `_", "title": "Fremdkostenposition", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "artikelbezeichnung": { + "description": "Bezeichnung für den Artikel für den die Kosten ermittelt wurden. Beispiel: Arbeitspreis HT", "title": "Artikelbezeichnung", "default": null, "anyOf": [ @@ -40,6 +43,7 @@ ] }, "artikeldetail": { + "description": "Detaillierung des Artikels (optional). Beispiel: 'Drehstromzähler'", "title": "Artikeldetail", "default": null, "anyOf": [ @@ -52,6 +56,7 @@ ] }, "betragKostenposition": { + "description": "Der errechnete Gesamtbetrag der Position als Ergebnis der Berechnung oder\n", "default": null, "anyOf": [ { @@ -63,6 +68,7 @@ ] }, "bis": { + "description": "exklusiver bis-Zeitpunkt der Kostenzeitscheibe", "title": "Bis", "default": null, "anyOf": [ @@ -76,6 +82,7 @@ ] }, "einzelpreis": { + "description": "Der Preis für eine Einheit. Beispiele: 5,8200 ct/kWh oder 55 €/Jahr.", "default": null, "anyOf": [ { @@ -87,6 +94,7 @@ ] }, "gebietcodeEic": { + "description": "EIC-Code des Regel- oder Marktgebietes eingetragen. Z.B. '10YDE-EON------1' für die Regelzone TenneT", "title": "Gebietcodeeic", "default": null, "anyOf": [ @@ -99,6 +107,7 @@ ] }, "linkPreisblatt": { + "description": "Link zum veröffentlichten Preisblatt", "title": "Linkpreisblatt", "default": null, "anyOf": [ @@ -111,6 +120,7 @@ ] }, "marktpartnercode": { + "description": "Die Codenummer (z.B. BDEW-Codenummer) des Marktpartners, der die Preise festlegt / die Kosten in Rechnung stellt", "title": "Marktpartnercode", "default": null, "anyOf": [ @@ -123,6 +133,7 @@ ] }, "marktpartnername": { + "description": "Der Name des Marktpartners, der die Preise festlegt, bzw. die Kosten in Rechnung stellt", "title": "Marktpartnername", "default": null, "anyOf": [ @@ -135,6 +146,7 @@ ] }, "menge": { + "description": "Die Menge, die in die Kostenberechnung eingeflossen ist. Beispiel: 3.660 kWh", "default": null, "anyOf": [ { @@ -146,6 +158,7 @@ ] }, "positionstitel": { + "description": "Ein Titel für die Zeile. Hier kann z.B. der Netzbetreiber eingetragen werden, wenn es sich um Netzkosten handelt.", "title": "Positionstitel", "default": null, "anyOf": [ @@ -158,6 +171,7 @@ ] }, "von": { + "description": "inklusiver von-Zeitpunkt der Kostenzeitscheibe", "title": "Von", "default": null, "anyOf": [ @@ -171,6 +185,7 @@ ] }, "zeitmenge": { + "description": "Wenn es einen zeitbasierten Preis gibt (z.B. €/Jahr), dann ist hier die Menge angegeben mit der die Kosten berechnet\nwurden. Z.B. 138 Tage.", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/Geokoordinaten.json b/unittests/test_data/bo4e_schemas/com/Geokoordinaten.json index 3e43535..482c7ad 100644 --- a/unittests/test_data/bo4e_schemas/com/Geokoordinaten.json +++ b/unittests/test_data/bo4e_schemas/com/Geokoordinaten.json @@ -1,9 +1,10 @@ { - "description": "This component provides the geo-coordinates for a location.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Geokoordinaten JSON Schema `_", + "description": "This component provides the geo-coordinates for a location.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Geokoordinaten JSON Schema `_", "title": "Geokoordinaten", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -32,8 +34,7 @@ "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -45,8 +46,7 @@ "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" diff --git a/unittests/test_data/bo4e_schemas/com/Katasteradresse.json b/unittests/test_data/bo4e_schemas/com/Katasteradresse.json index 4b13b8c..6315c4b 100644 --- a/unittests/test_data/bo4e_schemas/com/Katasteradresse.json +++ b/unittests/test_data/bo4e_schemas/com/Katasteradresse.json @@ -1,9 +1,10 @@ { - "description": "Dient der Adressierung über die Liegenschafts-Information.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Katasteradresse JSON Schema `_", + "description": "Dient der Adressierung über die Liegenschafts-Information.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Katasteradresse JSON Schema `_", "title": "Katasteradresse", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" diff --git a/unittests/test_data/bo4e_schemas/com/Messlokationszuordnung.json b/unittests/test_data/bo4e_schemas/com/Konfigurationsprodukt.json similarity index 53% rename from unittests/test_data/bo4e_schemas/com/Messlokationszuordnung.json rename to unittests/test_data/bo4e_schemas/com/Konfigurationsprodukt.json index 2bd85b9..e4cefb7 100644 --- a/unittests/test_data/bo4e_schemas/com/Messlokationszuordnung.json +++ b/unittests/test_data/bo4e_schemas/com/Konfigurationsprodukt.json @@ -1,9 +1,10 @@ { - "description": "Mit dieser Komponente werden Messlokationen zu Marktlokationen zugeordnet.\nDabei kann eine arithmetische Operation (Addition, Subtraktion, Multiplikation, Division) angegeben werden,\nmit der die Messlokation zum Verbrauch der Marktlokation beiträgt.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Messlokationszuordnung JSON Schema `_", - "title": "Messlokationszuordnung", + "description": "Object containing information about a Konfigurationsprodukt\n\n.. raw:: html\n\n \n\n.. HINT::\n `Konfigurationsprodukt JSON Schema `_", + "title": "Konfigurationsprodukt", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -27,45 +29,43 @@ } ] }, - "arithmetik": { + "leistungskurvendefinition": { + "title": "Leistungskurvendefinition", "default": null, "anyOf": [ { - "$ref": "../enum/ArithmetischeOperation.json#" + "type": "string" }, { "type": "null" } ] }, - "gueltigBis": { - "title": "Gueltigbis", + "marktpartner": { "default": null, "anyOf": [ { - "type": "string", - "format": "date-time" + "$ref": "../bo/Marktteilnehmer.json#" }, { "type": "null" } ] }, - "gueltigSeit": { - "title": "Gueltigseit", + "produktcode": { + "title": "Produktcode", "default": null, "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ] }, - "messlokationsId": { - "title": "Messlokationsid", + "schaltzeitdefinition": { + "title": "Schaltzeitdefinition", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/Kontaktweg.json b/unittests/test_data/bo4e_schemas/com/Kontaktweg.json new file mode 100644 index 0000000..0d863f8 --- /dev/null +++ b/unittests/test_data/bo4e_schemas/com/Kontaktweg.json @@ -0,0 +1,100 @@ +{ + "description": "Die Komponente wird dazu verwendet, die Kontaktwege innerhalb des BOs Person darzustellen\n\n.. raw:: html\n\n \n\n.. HINT::\n `Kontakt JSON Schema `_", + "title": "Kontaktweg", + "additionalProperties": true, + "properties": { + "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", + "title": " Id", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", + "title": " Version", + "default": "v202401.3.2", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "beschreibung": { + "description": "Spezifikation, beispielsweise \"Durchwahl\", \"Sammelnummer\" etc.", + "title": "Beschreibung", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "istBevorzugterKontaktweg": { + "description": "Gibt an, ob es sich um den bevorzugten Kontaktweg handelt.", + "title": "Istbevorzugterkontaktweg", + "default": null, + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, + "kontaktart": { + "description": "Gibt die Kontaktart des Kontaktes an.", + "default": null, + "anyOf": [ + { + "$ref": "../enum/Kontaktart.json#" + }, + { + "type": "null" + } + ] + }, + "kontaktwert": { + "description": "Die Nummer oder E-Mail-Adresse.", + "title": "Kontaktwert", + "default": null, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "zusatzAttribute": { + "title": "Zusatzattribute", + "default": null, + "anyOf": [ + { + "items": { + "$ref": "../ZusatzAttribut.json#" + }, + "type": "array" + }, + { + "type": "null" + } + ] + } + }, + "type": "object" +} diff --git a/unittests/test_data/bo4e_schemas/com/Konzessionsabgabe.json b/unittests/test_data/bo4e_schemas/com/Konzessionsabgabe.json index ace6cb6..980d6da 100644 --- a/unittests/test_data/bo4e_schemas/com/Konzessionsabgabe.json +++ b/unittests/test_data/bo4e_schemas/com/Konzessionsabgabe.json @@ -1,9 +1,10 @@ { - "description": "Diese Komponente wird zur Übertagung der Details zu einer Konzessionsabgabe verwendet.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Konzessionsabgabe JSON Schema `_", + "description": "Diese Komponente wird zur Übertagung der Details zu einer Konzessionsabgabe verwendet.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Konzessionsabgabe JSON Schema `_", "title": "Konzessionsabgabe", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "kategorie": { + "description": "Gebührenkategorie der Konzessionsabgabe", "title": "Kategorie", "default": null, "anyOf": [ @@ -40,12 +43,12 @@ ] }, "kosten": { + "description": "Konzessionsabgabe in E/kWh", "title": "Kosten", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -53,6 +56,7 @@ ] }, "satz": { + "description": "Art der Abgabe", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/Kostenblock.json b/unittests/test_data/bo4e_schemas/com/Kostenblock.json index 4917d15..1712c81 100644 --- a/unittests/test_data/bo4e_schemas/com/Kostenblock.json +++ b/unittests/test_data/bo4e_schemas/com/Kostenblock.json @@ -1,9 +1,10 @@ { - "description": "Mit dieser Komponente werden mehrere Kostenpositionen zusammengefasst.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Kostenblock JSON Schema `_", + "description": "Mit dieser Komponente werden mehrere Kostenpositionen zusammengefasst.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Kostenblock JSON Schema `_", "title": "Kostenblock", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "kostenblockbezeichnung": { + "description": "Bezeichnung für einen Kostenblock. Z.B. Netzkosten, Messkosten, Umlagen, etc.", "title": "Kostenblockbezeichnung", "default": null, "anyOf": [ @@ -40,6 +43,7 @@ ] }, "kostenpositionen": { + "description": "Hier sind die Details zu einer Kostenposition aufgeführt. Z.B.:\nAlliander Netz Heinsberg GmbH, 01.02.2018, 31.12.2018, Arbeitspreis HT, 3.660 kWh, 5,8200 ct/kWh, 213,01 €", "title": "Kostenpositionen", "default": null, "anyOf": [ @@ -55,6 +59,7 @@ ] }, "summeKostenblock": { + "description": "Die Summe aller Kostenpositionen dieses Blocks", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/Kostenposition.json b/unittests/test_data/bo4e_schemas/com/Kostenposition.json index 0905589..0d95c23 100644 --- a/unittests/test_data/bo4e_schemas/com/Kostenposition.json +++ b/unittests/test_data/bo4e_schemas/com/Kostenposition.json @@ -1,9 +1,10 @@ { - "description": "Diese Komponente wird zur Übertagung der Details zu einer Kostenposition verwendet.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Kostenposition JSON Schema `_", + "description": "Diese Komponente wird zur Übertagung der Details zu einer Kostenposition verwendet.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Kostenposition JSON Schema `_", "title": "Kostenposition", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "artikelbezeichnung": { + "description": "Bezeichnung für den Artikel für den die Kosten ermittelt wurden. Beispiel: Arbeitspreis HT", "title": "Artikelbezeichnung", "default": null, "anyOf": [ @@ -40,6 +43,7 @@ ] }, "artikeldetail": { + "description": "Detaillierung des Artikels (optional). Beispiel: 'Drehstromzähler'", "title": "Artikeldetail", "default": null, "anyOf": [ @@ -52,6 +56,7 @@ ] }, "betragKostenposition": { + "description": "Der errechnete Gesamtbetrag der Position als Ergebnis der Berechnung oder\n", "default": null, "anyOf": [ { @@ -63,6 +68,7 @@ ] }, "bis": { + "description": "exklusiver bis-Zeitpunkt der Kostenzeitscheibe", "title": "Bis", "default": null, "anyOf": [ @@ -76,6 +82,7 @@ ] }, "einzelpreis": { + "description": "Der Preis für eine Einheit. Beispiele: 5,8200 ct/kWh oder 55 €/Jahr.", "default": null, "anyOf": [ { @@ -87,6 +94,7 @@ ] }, "menge": { + "description": "Die Menge, die in die Kostenberechnung eingeflossen ist. Beispiel: 3.660 kWh", "default": null, "anyOf": [ { @@ -98,6 +106,7 @@ ] }, "positionstitel": { + "description": "Ein Titel für die Zeile. Hier kann z.B. der Netzbetreiber eingetragen werden, wenn es sich um Netzkosten handelt.", "title": "Positionstitel", "default": null, "anyOf": [ @@ -110,6 +119,7 @@ ] }, "von": { + "description": "inklusiver von-Zeitpunkt der Kostenzeitscheibe", "title": "Von", "default": null, "anyOf": [ @@ -123,6 +133,7 @@ ] }, "zeitmenge": { + "description": "Wenn es einen zeitbasierten Preis gibt (z.B. €/Jahr), dann ist hier die Menge angegeben mit der die Kosten berechnet\nwurden. Z.B. 138 Tage.", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/KriteriumWert.json b/unittests/test_data/bo4e_schemas/com/KriteriumWert.json index 8ed6a47..f361ab2 100644 --- a/unittests/test_data/bo4e_schemas/com/KriteriumWert.json +++ b/unittests/test_data/bo4e_schemas/com/KriteriumWert.json @@ -1,9 +1,10 @@ { - "description": "Mit dieser Komponente können Kriterien und deren Werte definiert werden\n\n.. raw:: html\n\n \n\n.. HINT::\n `KriteriumWert JSON Schema `_", + "description": "Mit dieser Komponente können Kriterien und deren Werte definiert werden\n\n.. raw:: html\n\n \n\n.. HINT::\n `KriteriumWert JSON Schema `_", "title": "KriteriumWert", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "kriterium": { + "description": "Hier steht, für welches Kriterium der Wert gilt. Z.B. Postleitzahlen", "default": null, "anyOf": [ { @@ -39,6 +42,7 @@ ] }, "wert": { + "description": "Ein Wert, passend zum Kriterium. Z.B. eine Postleitzahl.", "title": "Wert", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/MarktgebietInfo.json b/unittests/test_data/bo4e_schemas/com/MarktgebietInfo.json index a80074f..317d135 100644 --- a/unittests/test_data/bo4e_schemas/com/MarktgebietInfo.json +++ b/unittests/test_data/bo4e_schemas/com/MarktgebietInfo.json @@ -1,9 +1,10 @@ { - "description": "Informationen zum Marktgebiet im Gas.\n\n.. raw:: html\n\n \n\n.. HINT::\n `MarktgebietInfo JSON Schema `_", + "description": "Informationen zum Marktgebiet im Gas.\n\n.. raw:: html\n\n \n\n.. HINT::\n `MarktgebietInfo JSON Schema `_", "title": "MarktgebietInfo", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "marktgebiet": { + "description": "Der Name des Marktgebietes", "title": "Marktgebiet", "default": null, "anyOf": [ @@ -40,6 +43,7 @@ ] }, "marktgebietcode": { + "description": "Der Name des Marktgebietes", "title": "Marktgebietcode", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/Menge.json b/unittests/test_data/bo4e_schemas/com/Menge.json index be59120..cc9cc4f 100644 --- a/unittests/test_data/bo4e_schemas/com/Menge.json +++ b/unittests/test_data/bo4e_schemas/com/Menge.json @@ -1,9 +1,10 @@ { - "description": "Abbildung einer Menge mit Wert und Einheit.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Menge JSON Schema `_", + "description": "Abbildung einer Menge mit Wert und Einheit.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Menge JSON Schema `_", "title": "Menge", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "einheit": { + "description": "Gibt die Einheit zum jeweiligen Wert an", "default": null, "anyOf": [ { @@ -39,12 +42,12 @@ ] }, "wert": { + "description": "Gibt den absoluten Wert der Menge an", "title": "Wert", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" diff --git a/unittests/test_data/bo4e_schemas/com/PositionsAufAbschlag.json b/unittests/test_data/bo4e_schemas/com/PositionsAufAbschlag.json index 0beadda..f44dd4e 100644 --- a/unittests/test_data/bo4e_schemas/com/PositionsAufAbschlag.json +++ b/unittests/test_data/bo4e_schemas/com/PositionsAufAbschlag.json @@ -1,9 +1,10 @@ { - "description": "Differenzierung der zu betrachtenden Produkte anhand der preiserhöhenden (Aufschlag)\nbzw. preisvermindernden (Abschlag) Zusatzvereinbarungen,\ndie individuell zu einem neuen oder bestehenden Liefervertrag abgeschlossen werden können.\nEs können mehrere Auf-/Abschläge gleichzeitig ausgewählt werden.\n\n.. raw:: html\n\n \n\n.. HINT::\n `PositionsAufAbschlag JSON Schema `_", + "description": "Differenzierung der zu betrachtenden Produkte anhand der preiserhöhenden (Aufschlag)\nbzw. preisvermindernden (Abschlag) Zusatzvereinbarungen,\ndie individuell zu einem neuen oder bestehenden Liefervertrag abgeschlossen werden können.\nEs können mehrere Auf-/Abschläge gleichzeitig ausgewählt werden.\n\n.. raw:: html\n\n \n\n.. HINT::\n `PositionsAufAbschlag JSON Schema `_", "title": "PositionsAufAbschlag", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "aufAbschlagstyp": { + "description": "Typ des AufAbschlages", "default": null, "anyOf": [ { @@ -39,6 +42,7 @@ ] }, "aufAbschlagswaehrung": { + "description": "Einheit, in der der Auf-/Abschlag angegeben ist (z.B. ct/kWh).", "default": null, "anyOf": [ { @@ -50,12 +54,12 @@ ] }, "aufAbschlagswert": { + "description": "Höhe des Auf-/Abschlages", "title": "Aufabschlagswert", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -63,6 +67,7 @@ ] }, "beschreibung": { + "description": "Beschreibung zum Auf-/Abschlag", "title": "Beschreibung", "default": null, "anyOf": [ @@ -75,6 +80,7 @@ ] }, "bezeichnung": { + "description": "Bezeichnung des Auf-/Abschlags", "title": "Bezeichnung", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/Preis.json b/unittests/test_data/bo4e_schemas/com/Preis.json index fa22758..b548485 100644 --- a/unittests/test_data/bo4e_schemas/com/Preis.json +++ b/unittests/test_data/bo4e_schemas/com/Preis.json @@ -1,9 +1,10 @@ { - "description": "Abbildung eines Preises mit Wert, Einheit, Bezugswert und Status.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Preis JSON Schema `_", + "description": "Abbildung eines Preises mit Wert, Einheit, Bezugswert und Status.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Preis JSON Schema `_", "title": "Preis", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "bezugswert": { + "description": "Angabe, für welche Bezugsgröße der Preis gilt. Z.B. kWh.", "default": null, "anyOf": [ { @@ -39,6 +42,7 @@ ] }, "einheit": { + "description": "Währungseinheit für den Preis, z.B. Euro oder Ct.", "default": null, "anyOf": [ { @@ -50,6 +54,7 @@ ] }, "status": { + "description": "Gibt den Status des veröffentlichten Preises an", "default": null, "anyOf": [ { @@ -61,12 +66,12 @@ ] }, "wert": { + "description": "Gibt die nominale Höhe des Preises an.", "title": "Wert", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" diff --git a/unittests/test_data/bo4e_schemas/com/Preisgarantie.json b/unittests/test_data/bo4e_schemas/com/Preisgarantie.json index 96f7d6e..aa31634 100644 --- a/unittests/test_data/bo4e_schemas/com/Preisgarantie.json +++ b/unittests/test_data/bo4e_schemas/com/Preisgarantie.json @@ -1,9 +1,10 @@ { - "description": "Definition für eine Preisgarantie mit der Möglichkeit verschiedener Ausprägungen.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Preisgarantie JSON Schema `_", + "description": "Definition für eine Preisgarantie mit der Möglichkeit verschiedener Ausprägungen.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Preisgarantie JSON Schema `_", "title": "Preisgarantie", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "beschreibung": { + "description": "Freitext zur Beschreibung der Preisgarantie.", "title": "Beschreibung", "default": null, "anyOf": [ @@ -40,6 +43,7 @@ ] }, "preisgarantietyp": { + "description": "Festlegung, auf welche Preisbestandteile die Garantie gewährt wird.", "default": null, "anyOf": [ { @@ -51,6 +55,7 @@ ] }, "zeitlicheGueltigkeit": { + "description": "Zeitraum, bis zu dem die Preisgarantie gilt, z.B. bis zu einem absolutem / fixem Datum\noder als Laufzeit in Monaten. ", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/Preisposition.json b/unittests/test_data/bo4e_schemas/com/Preisposition.json index ff8e6e7..2c643e2 100644 --- a/unittests/test_data/bo4e_schemas/com/Preisposition.json +++ b/unittests/test_data/bo4e_schemas/com/Preisposition.json @@ -1,9 +1,10 @@ { - "description": "Preis für eine definierte Lieferung oder Leistung innerhalb eines Preisblattes\n\n.. raw:: html\n\n \n\n.. HINT::\n `Preisposition JSON Schema `_", + "description": "Preis für eine definierte Lieferung oder Leistung innerhalb eines Preisblattes\n\n.. raw:: html\n\n \n\n.. HINT::\n `Preisposition JSON Schema `_", "title": "Preisposition", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "bdewArtikelnummer": { + "description": "Eine vom BDEW standardisierte Bezeichnug für die abgerechnete Leistungserbringung;\nDiese Artikelnummer wird auch im Rechnungsteil der INVOIC verwendet.", "default": null, "anyOf": [ { @@ -39,6 +42,7 @@ ] }, "berechnungsmethode": { + "description": "Das Modell, das der Preisbildung zugrunde liegt", "default": null, "anyOf": [ { @@ -50,6 +54,7 @@ ] }, "bezugsgroesse": { + "description": "Hier wird festgelegt, auf welche Bezugsgrösse sich der Preis bezieht, z.B. kWh oder Stück", "default": null, "anyOf": [ { @@ -61,12 +66,12 @@ ] }, "freimengeBlindarbeit": { + "description": "Der Anteil der Menge der Blindarbeit in Prozent von der Wirkarbeit, für die keine Abrechnung erfolgt", "title": "Freimengeblindarbeit", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -74,12 +79,12 @@ ] }, "freimengeLeistungsfaktor": { + "description": "Der cos phi (Verhältnis Wirkleistung/Scheinleistung) aus dem die Freimenge für die Blindarbeit berechnet wird als\ntan phi (Verhältnis Blindleistung/Wirkleistung)", "title": "Freimengeleistungsfaktor", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -87,6 +92,7 @@ ] }, "gruppenartikelId": { + "description": "Übergeordnete Gruppen-ID, die sich ggf. auf die Artikel-ID in der Preisstaffel bezieht", "title": "Gruppenartikelid", "default": null, "anyOf": [ @@ -99,6 +105,7 @@ ] }, "leistungsbezeichnung": { + "description": "Bezeichnung für die in der Position abgebildete Leistungserbringung", "title": "Leistungsbezeichnung", "default": null, "anyOf": [ @@ -111,6 +118,7 @@ ] }, "leistungstyp": { + "description": "Standardisierte Bezeichnung für die abgerechnete Leistungserbringung", "default": null, "anyOf": [ { @@ -122,6 +130,7 @@ ] }, "preiseinheit": { + "description": "Festlegung, mit welcher Preiseinheit abgerechnet wird, z.B. Ct. oder €", "default": null, "anyOf": [ { @@ -133,6 +142,7 @@ ] }, "preisstaffeln": { + "description": "Preisstaffeln, die zu dieser Preisposition gehören", "title": "Preisstaffeln", "default": null, "anyOf": [ @@ -148,6 +158,7 @@ ] }, "tarifzeit": { + "description": "Festlegung, für welche Tarifzeit der Preis hier festgelegt ist", "default": null, "anyOf": [ { @@ -159,6 +170,7 @@ ] }, "zeitbasis": { + "description": "Die Zeit(dauer) auf die sich der Preis bezieht.\nZ.B. ein Jahr für einen Leistungspreis der in €/kW/Jahr ausgegeben wird", "default": null, "anyOf": [ { @@ -170,6 +182,7 @@ ] }, "zonungsgroesse": { + "description": "Mit der Menge der hier angegebenen Größe wird die Staffelung/Zonung durchgeführt. Z.B. Vollbenutzungsstunden", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/Preisstaffel.json b/unittests/test_data/bo4e_schemas/com/Preisstaffel.json index 8d9d684..e4afd4a 100644 --- a/unittests/test_data/bo4e_schemas/com/Preisstaffel.json +++ b/unittests/test_data/bo4e_schemas/com/Preisstaffel.json @@ -1,9 +1,10 @@ { - "description": "Gibt die Staffelgrenzen der jeweiligen Preise an\n\n.. raw:: html\n\n \n\n.. HINT::\n `Preisstaffel JSON Schema `_", + "description": "Gibt die Staffelgrenzen der jeweiligen Preise an\n\n.. raw:: html\n\n \n\n.. HINT::\n `Preisstaffel JSON Schema `_", "title": "Preisstaffel", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,12 +30,12 @@ ] }, "einheitspreis": { + "description": "Preis pro abgerechneter Mengeneinheit", "title": "Einheitspreis", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -41,6 +43,7 @@ ] }, "sigmoidparameter": { + "description": "Parameter zur Berechnung des Preises anhand der Jahresmenge und weiterer netzbezogener Parameter", "default": null, "anyOf": [ { @@ -52,12 +55,12 @@ ] }, "staffelgrenzeBis": { + "description": "Exklusiver oberer Wert, bis zu dem die Staffel gilt", "title": "Staffelgrenzebis", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -65,12 +68,12 @@ ] }, "staffelgrenzeVon": { + "description": "Inklusiver unterer Wert, ab dem die Staffel gilt", "title": "Staffelgrenzevon", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" diff --git a/unittests/test_data/bo4e_schemas/com/Rechnungsposition.json b/unittests/test_data/bo4e_schemas/com/Rechnungsposition.json index af0b3d3..2c94b74 100644 --- a/unittests/test_data/bo4e_schemas/com/Rechnungsposition.json +++ b/unittests/test_data/bo4e_schemas/com/Rechnungsposition.json @@ -1,9 +1,10 @@ { - "description": "Über Rechnungspositionen werden Rechnungen strukturiert.\nIn einem Rechnungsteil wird jeweils eine in sich geschlossene Leistung abgerechnet.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Rechnungsposition JSON Schema `_", + "description": "Über Rechnungspositionen werden Rechnungen strukturiert.\nIn einem Rechnungsteil wird jeweils eine in sich geschlossene Leistung abgerechnet.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Rechnungsposition JSON Schema `_", "title": "Rechnungsposition", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "artikelId": { + "description": "Standardisierte vom BDEW herausgegebene Liste, welche im Strommarkt die BDEW-Artikelnummer ablöst", "title": "Artikelid", "default": null, "anyOf": [ @@ -40,6 +43,7 @@ ] }, "artikelnummer": { + "description": "Kennzeichnung der Rechnungsposition mit der Standard-Artikelnummer des BDEW", "default": null, "anyOf": [ { @@ -51,6 +55,7 @@ ] }, "einzelpreis": { + "description": "Der Preis für eine Einheit der energetischen Menge", "default": null, "anyOf": [ { @@ -62,6 +67,7 @@ ] }, "lieferungBis": { + "description": "Ende der Lieferung für die abgerechnete Leistung (exklusiv)", "title": "Lieferungbis", "default": null, "anyOf": [ @@ -75,6 +81,7 @@ ] }, "lieferungVon": { + "description": "Start der Lieferung für die abgerechnete Leistung (inklusiv)", "title": "Lieferungvon", "default": null, "anyOf": [ @@ -88,6 +95,7 @@ ] }, "lokationsId": { + "description": "Marktlokation, die zu dieser Position gehört", "title": "Lokationsid", "default": null, "anyOf": [ @@ -100,6 +108,7 @@ ] }, "positionsMenge": { + "description": "Die abgerechnete Menge mit Einheit", "default": null, "anyOf": [ { @@ -111,6 +120,7 @@ ] }, "positionsnummer": { + "description": "Fortlaufende Nummer für die Rechnungsposition", "title": "Positionsnummer", "default": null, "anyOf": [ @@ -123,6 +133,7 @@ ] }, "positionstext": { + "description": "Bezeichung für die abgerechnete Position", "title": "Positionstext", "default": null, "anyOf": [ @@ -135,6 +146,7 @@ ] }, "teilrabattNetto": { + "description": "Nettobetrag für den Rabatt dieser Position", "default": null, "anyOf": [ { @@ -146,6 +158,7 @@ ] }, "teilsummeNetto": { + "description": "Das Ergebnis der Multiplikation aus einzelpreis * positionsMenge * (Faktor aus zeitbezogeneMenge).\nZ.B. 12,60€ * 120 kW * 3/12 (für 3 Monate).", "default": null, "anyOf": [ { @@ -157,6 +170,7 @@ ] }, "teilsummeSteuer": { + "description": "Auf die Position entfallende Steuer, bestehend aus Steuersatz und Betrag", "default": null, "anyOf": [ { @@ -168,6 +182,7 @@ ] }, "zeitbezogeneMenge": { + "description": "Eine auf die Zeiteinheit bezogene Untermenge.\nZ.B. bei einem Jahrespreis, 3 Monate oder 146 Tage.\nBasierend darauf wird der Preis aufgeteilt.", "default": null, "anyOf": [ { @@ -179,6 +194,7 @@ ] }, "zeiteinheit": { + "description": "Falls sich der Preis auf eine Zeit bezieht, steht hier die Einheit", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/RegionaleGueltigkeit.json b/unittests/test_data/bo4e_schemas/com/RegionaleGueltigkeit.json index 23d362b..5635348 100644 --- a/unittests/test_data/bo4e_schemas/com/RegionaleGueltigkeit.json +++ b/unittests/test_data/bo4e_schemas/com/RegionaleGueltigkeit.json @@ -1,9 +1,10 @@ { - "description": "Mit dieser Komponente können regionale Gültigkeiten, z.B. für Tarife, Zu- und Abschläge und Preise definiert werden.\n\n.. raw:: html\n\n \n\n.. HINT::\n `RegionaleGueltigkeit JSON Schema `_", + "description": "Mit dieser Komponente können regionale Gültigkeiten, z.B. für Tarife, Zu- und Abschläge und Preise definiert werden.\n\n.. raw:: html\n\n \n\n.. HINT::\n `RegionaleGueltigkeit JSON Schema `_", "title": "RegionaleGueltigkeit", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "gueltigkeitstyp": { + "description": "Unterscheidung ob Positivliste oder Negativliste übertragen wird", "default": null, "anyOf": [ { @@ -39,6 +42,7 @@ ] }, "kriteriumsWerte": { + "description": "Hier stehen die Kriterien, die die regionale Gültigkeit festlegen", "title": "Kriteriumswerte", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/RegionalePreisgarantie.json b/unittests/test_data/bo4e_schemas/com/RegionalePreisgarantie.json index a52cf22..1ed8128 100644 --- a/unittests/test_data/bo4e_schemas/com/RegionalePreisgarantie.json +++ b/unittests/test_data/bo4e_schemas/com/RegionalePreisgarantie.json @@ -1,9 +1,10 @@ { - "description": "Abbildung einer Preisgarantie mit regionaler Abgrenzung\n\n.. raw:: html\n\n \n\n.. HINT::\n `RegionalePreisgarantie JSON Schema `_", + "description": "Abbildung einer Preisgarantie mit regionaler Abgrenzung\n\n.. raw:: html\n\n \n\n.. HINT::\n `RegionalePreisgarantie JSON Schema `_", "title": "RegionalePreisgarantie", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "beschreibung": { + "description": "Freitext zur Beschreibung der Preisgarantie.", "title": "Beschreibung", "default": null, "anyOf": [ @@ -40,6 +43,7 @@ ] }, "preisgarantietyp": { + "description": "Festlegung, auf welche Preisbestandteile die Garantie gewährt wird.", "default": null, "anyOf": [ { @@ -51,6 +55,7 @@ ] }, "regionaleGueltigkeit": { + "description": "Regionale Eingrenzung der Preisgarantie.", "default": null, "anyOf": [ { @@ -62,6 +67,7 @@ ] }, "zeitlicheGueltigkeit": { + "description": "Zeitraum, bis zu dem die Preisgarantie gilt, z.B. bis zu einem absolutem / fixem Datum\noder als Laufzeit in Monaten. ", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/RegionalePreisstaffel.json b/unittests/test_data/bo4e_schemas/com/RegionalePreisstaffel.json index 38f800c..04a2a5a 100644 --- a/unittests/test_data/bo4e_schemas/com/RegionalePreisstaffel.json +++ b/unittests/test_data/bo4e_schemas/com/RegionalePreisstaffel.json @@ -1,9 +1,10 @@ { - "description": "Abbildung einer Preisstaffel mit regionaler Abgrenzung\n\n.. raw:: html\n\n \n\n.. HINT::\n `RegionalePreisstaffel JSON Schema `_", + "description": "Abbildung einer Preisstaffel mit regionaler Abgrenzung\n\n.. raw:: html\n\n \n\n.. HINT::\n `RegionalePreisstaffel JSON Schema `_", "title": "RegionalePreisstaffel", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,12 +30,12 @@ ] }, "einheitspreis": { + "description": "Preis pro abgerechneter Mengeneinheit", "title": "Einheitspreis", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -41,6 +43,7 @@ ] }, "regionaleGueltigkeit": { + "description": "Regionale Eingrenzung der Preisstaffel", "default": null, "anyOf": [ { @@ -52,6 +55,7 @@ ] }, "sigmoidparameter": { + "description": "Parameter zur Berechnung des Preises anhand der Jahresmenge und weiterer netzbezogener Parameter", "default": null, "anyOf": [ { @@ -63,12 +67,12 @@ ] }, "staffelgrenzeBis": { + "description": "Exklusiver oberer Wert, bis zu dem die Staffel gilt", "title": "Staffelgrenzebis", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -76,12 +80,12 @@ ] }, "staffelgrenzeVon": { + "description": "Inklusiver unterer Wert, ab dem die Staffel gilt", "title": "Staffelgrenzevon", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" diff --git a/unittests/test_data/bo4e_schemas/com/RegionaleTarifpreisposition.json b/unittests/test_data/bo4e_schemas/com/RegionaleTarifpreisposition.json index a7b0af1..a9eb7b2 100644 --- a/unittests/test_data/bo4e_schemas/com/RegionaleTarifpreisposition.json +++ b/unittests/test_data/bo4e_schemas/com/RegionaleTarifpreisposition.json @@ -1,9 +1,10 @@ { - "description": "Mit dieser Komponente können Tarifpreise verschiedener Typen im Zusammenhang mit regionalen Gültigkeiten abgebildet\nwerden.\n\n.. raw:: html\n\n \n\n.. HINT::\n `RegionaleTarifpreisposition JSON Schema `_", + "description": "Mit dieser Komponente können Tarifpreise verschiedener Typen im Zusammenhang mit regionalen Gültigkeiten abgebildet\nwerden.\n\n.. raw:: html\n\n \n\n.. HINT::\n `RegionaleTarifpreisposition JSON Schema `_", "title": "RegionaleTarifpreisposition", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "bezugseinheit": { + "description": "Größe, auf die sich die Einheit bezieht, beispielsweise kWh, Jahr", "default": null, "anyOf": [ { @@ -39,6 +42,7 @@ ] }, "einheit": { + "description": "Einheit des Preises (z.B. EURO)", "default": null, "anyOf": [ { @@ -50,6 +54,7 @@ ] }, "mengeneinheitstaffel": { + "description": "Gibt an, nach welcher Menge die vorgenannte Einschränkung erfolgt (z.B. Jahresstromverbrauch in kWh)", "default": null, "anyOf": [ { @@ -61,6 +66,7 @@ ] }, "preisstaffeln": { + "description": "Hier sind die Staffeln mit ihren Preisangaben und regionalen Gültigkeiten definiert", "title": "Preisstaffeln", "default": null, "anyOf": [ @@ -76,6 +82,7 @@ ] }, "preistyp": { + "description": "Angabe des Preistypes (z.B. Grundpreis)", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/RegionalerAufAbschlag.json b/unittests/test_data/bo4e_schemas/com/RegionalerAufAbschlag.json index 35c691e..90bddce 100644 --- a/unittests/test_data/bo4e_schemas/com/RegionalerAufAbschlag.json +++ b/unittests/test_data/bo4e_schemas/com/RegionalerAufAbschlag.json @@ -1,9 +1,10 @@ { - "description": "Mit dieser Komponente können Auf- und Abschläge verschiedener Typen im Zusammenhang mit regionalen Gültigkeiten\nabgebildet werden.\nHier sind auch die Auswirkungen auf verschiedene Tarifparameter modelliert, die sich durch die Auswahl eines Auf-\noder Abschlags ergeben.\n\n.. raw:: html\n\n \n\n.. HINT::\n `RegionalerAufAbschlag JSON Schema `_", + "description": "Mit dieser Komponente können Auf- und Abschläge verschiedener Typen im Zusammenhang mit regionalen Gültigkeiten\nabgebildet werden.\nHier sind auch die Auswirkungen auf verschiedene Tarifparameter modelliert, die sich durch die Auswahl eines Auf-\noder Abschlags ergeben.\n\n.. raw:: html\n\n \n\n.. HINT::\n `RegionalerAufAbschlag JSON Schema `_", "title": "RegionalerAufAbschlag", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "aufAbschlagstyp": { + "description": "Typ des Aufabschlages (z.B. absolut oder prozentual)", "default": null, "anyOf": [ { @@ -39,6 +42,7 @@ ] }, "aufAbschlagsziel": { + "description": "Diesem Preis oder den Kosten ist der Auf/Abschlag zugeordnet. Z.B. Arbeitspreis, Gesamtpreis etc.", "default": null, "anyOf": [ { @@ -50,6 +54,7 @@ ] }, "beschreibung": { + "description": "Beschreibung des Auf-/Abschlags", "title": "Beschreibung", "default": null, "anyOf": [ @@ -62,6 +67,7 @@ ] }, "bezeichnung": { + "description": "Bezeichnung des Auf-/Abschlags", "title": "Bezeichnung", "default": null, "anyOf": [ @@ -74,6 +80,7 @@ ] }, "einheit": { + "description": "Gibt an in welcher Währungseinheit der Auf/Abschlag berechnet wird (nur im Falle absoluter Aufschlagstypen).", "default": null, "anyOf": [ { @@ -85,6 +92,7 @@ ] }, "einschraenkungsaenderung": { + "description": "Änderungen in den Einschränkungen zum Tarif;\nFalls in dieser Komponenten angegeben, werden die Tarifparameter hiermit überschrieben.", "default": null, "anyOf": [ { @@ -96,6 +104,7 @@ ] }, "energiemixaenderung": { + "description": "Der Energiemix kann sich durch einen AufAbschlag ändern (z.B. zwei Cent Aufschlag für Ökostrom).\nSollte dies der Fall sein, wird hier die neue Zusammensetzung des Energiemix angegeben.", "default": null, "anyOf": [ { @@ -107,6 +116,7 @@ ] }, "garantieaenderung": { + "description": "Änderungen in den Garantievereinbarungen;\nFalls in dieser Komponenten angegeben, werden die Tarifparameter hiermit überschrieben.", "default": null, "anyOf": [ { @@ -118,6 +128,7 @@ ] }, "gueltigkeitszeitraum": { + "description": "Zeitraum, in dem der Abschlag zur Anwendung kommen kann", "default": null, "anyOf": [ { @@ -129,6 +140,7 @@ ] }, "staffeln": { + "description": "Werte für die gestaffelten Auf/Abschläge mit regionaler Eingrenzung", "title": "Staffeln", "default": null, "anyOf": [ @@ -144,6 +156,7 @@ ] }, "tarifnamensaenderungen": { + "description": "Durch die Anwendung des Auf/Abschlags kann eine Änderung des Tarifnamens auftreten", "title": "Tarifnamensaenderungen", "default": null, "anyOf": [ @@ -156,6 +169,7 @@ ] }, "vertagskonditionsaenderung": { + "description": "Änderungen in den Vertragskonditionen;\nFalls in dieser Komponenten angegeben, werden die Tarifparameter hiermit überschrieben.", "default": null, "anyOf": [ { @@ -167,6 +181,7 @@ ] }, "voraussetzungen": { + "description": "Voraussetzungen, die erfüllt sein müssen, damit dieser AufAbschlag zur Anwendung kommen kann", "title": "Voraussetzungen", "default": null, "anyOf": [ @@ -182,6 +197,7 @@ ] }, "website": { + "description": "Internetseite, auf der die Informationen zum Auf-/Abschlag veröffentlicht sind", "title": "Website", "default": null, "anyOf": [ @@ -209,6 +225,7 @@ ] }, "zusatzprodukte": { + "description": "Zusatzprodukte, die nur in Kombination mit diesem AufAbschlag erhältlich sind", "title": "Zusatzprodukte", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/Regionskriterium.json b/unittests/test_data/bo4e_schemas/com/Regionskriterium.json index 9a6a8b7..2850d41 100644 --- a/unittests/test_data/bo4e_schemas/com/Regionskriterium.json +++ b/unittests/test_data/bo4e_schemas/com/Regionskriterium.json @@ -1,9 +1,10 @@ { - "description": "Komponente zur Abbildung eines Regionskriteriums\n\n.. raw:: html\n\n \n\n.. HINT::\n `Regionskriterium JSON Schema `_", + "description": "Komponente zur Abbildung eines Regionskriteriums\n\n.. raw:: html\n\n \n\n.. HINT::\n `Regionskriterium JSON Schema `_", "title": "Regionskriterium", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "gueltigkeitstyp": { + "description": "Hier wird festgelegt, ob es sich um ein einschließendes oder ausschließendes Kriterium handelt.", "default": null, "anyOf": [ { @@ -39,6 +42,7 @@ ] }, "regionskriteriumtyp": { + "description": "Hier wird das Kriterium selbst angegeben, z.B. Bundesland.", "default": null, "anyOf": [ { @@ -50,6 +54,7 @@ ] }, "wert": { + "description": "Der Wert, den das Kriterium annehmen kann, z.B. NRW.\nIm Falle des Regionskriteriumstyp BUNDESWEIT spielt dieser Wert keine Rolle.", "title": "Wert", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/Rufnummer.json b/unittests/test_data/bo4e_schemas/com/Rufnummer.json deleted file mode 100644 index a08579d..0000000 --- a/unittests/test_data/bo4e_schemas/com/Rufnummer.json +++ /dev/null @@ -1,70 +0,0 @@ -{ - "description": "Contains information to call or fax someone\n\n.. raw:: html\n\n \n\n.. HINT::\n `Rufnummer JSON Schema `_", - "title": "Rufnummer", - "additionalProperties": true, - "properties": { - "_id": { - "title": " Id", - "default": null, - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "_version": { - "title": " Version", - "default": "v202401.0.1", - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "nummerntyp": { - "default": null, - "anyOf": [ - { - "$ref": "../enum/Rufnummernart.json#" - }, - { - "type": "null" - } - ] - }, - "rufnummer": { - "title": "Rufnummer", - "default": null, - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "zusatzAttribute": { - "title": "Zusatzattribute", - "default": null, - "anyOf": [ - { - "items": { - "$ref": "../ZusatzAttribut.json#" - }, - "type": "array" - }, - { - "type": "null" - } - ] - } - }, - "type": "object" -} diff --git a/unittests/test_data/bo4e_schemas/com/Sigmoidparameter.json b/unittests/test_data/bo4e_schemas/com/Sigmoidparameter.json index 047463d..cc02972 100644 --- a/unittests/test_data/bo4e_schemas/com/Sigmoidparameter.json +++ b/unittests/test_data/bo4e_schemas/com/Sigmoidparameter.json @@ -1,15 +1,15 @@ { - "description": "Die Sigmoid-Funktion, beispielsweise zur Berechnung eines Leistungspreises hat die Form:\nLP=A/(1+(P/B)^C)+D\n\n.. raw:: html\n\n \n\n.. HINT::\n `Sigmoidparameter JSON Schema `_", + "description": "Die Sigmoid-Funktion, beispielsweise zur Berechnung eines Leistungspreises hat die Form:\nLP=A/(1+(P/B)^C)+D\n\n.. raw:: html\n\n \n\n.. HINT::\n `Sigmoidparameter JSON Schema `_", "title": "Sigmoidparameter", "additionalProperties": true, "properties": { "A": { + "description": "Briefmarke Ortsverteilnetz (EUR/kWh)", "title": "A", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -17,12 +17,12 @@ ] }, "B": { + "description": "Briefmarke Ortsverteilnetz (EUR/kWh)", "title": "B", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -30,12 +30,12 @@ ] }, "C": { + "description": "Wendepunkt für die bepreiste Menge (kW)", "title": "C", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -43,12 +43,12 @@ ] }, "D": { + "description": "Exponent (einheitenlos)", "title": "D", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -56,6 +56,7 @@ ] }, "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -68,8 +69,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" diff --git a/unittests/test_data/bo4e_schemas/com/StandorteigenschaftenGas.json b/unittests/test_data/bo4e_schemas/com/StandorteigenschaftenGas.json index 758d1e7..a2c4e2a 100644 --- a/unittests/test_data/bo4e_schemas/com/StandorteigenschaftenGas.json +++ b/unittests/test_data/bo4e_schemas/com/StandorteigenschaftenGas.json @@ -1,9 +1,10 @@ { - "description": "Standorteigenschaften der Sparte Gas\n\n.. raw:: html\n\n \n\n.. HINT::\n `StandorteigenschaftenGas JSON Schema `_", + "description": "Standorteigenschaften der Sparte Gas\n\n.. raw:: html\n\n \n\n.. HINT::\n `StandorteigenschaftenGas JSON Schema `_", "title": "StandorteigenschaftenGas", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "marktgebiete": { + "description": "Netzkontonummern der Gasnetze", "title": "Marktgebiete", "default": null, "anyOf": [ @@ -43,6 +46,7 @@ ] }, "netzkontonummern": { + "description": "Netzkontonummern der Gasnetze", "title": "Netzkontonummern", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/StandorteigenschaftenStrom.json b/unittests/test_data/bo4e_schemas/com/StandorteigenschaftenStrom.json index c7958b9..a61e4f9 100644 --- a/unittests/test_data/bo4e_schemas/com/StandorteigenschaftenStrom.json +++ b/unittests/test_data/bo4e_schemas/com/StandorteigenschaftenStrom.json @@ -1,9 +1,10 @@ { - "description": "Standorteigenschaften der Sparte Strom\n\n.. raw:: html\n\n \n\n.. HINT::\n `StandorteigenschaftenStrom JSON Schema `_", + "description": "Standorteigenschaften der Sparte Strom\n\n.. raw:: html\n\n \n\n.. HINT::\n `StandorteigenschaftenStrom JSON Schema `_", "title": "StandorteigenschaftenStrom", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "bilanzierungsgebietEic": { + "description": "Die EIC-Nummer des Bilanzierungsgebietes", "title": "Bilanzierungsgebieteic", "default": null, "anyOf": [ @@ -40,6 +43,7 @@ ] }, "regelzone": { + "description": "Der Name der Regelzone", "title": "Regelzone", "default": null, "anyOf": [ @@ -52,6 +56,7 @@ ] }, "regelzoneEic": { + "description": "De EIC-Nummer der Regelzone", "title": "Regelzoneeic", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/Steuerbetrag.json b/unittests/test_data/bo4e_schemas/com/Steuerbetrag.json index 06c245f..66b1f8c 100644 --- a/unittests/test_data/bo4e_schemas/com/Steuerbetrag.json +++ b/unittests/test_data/bo4e_schemas/com/Steuerbetrag.json @@ -1,9 +1,10 @@ { - "description": "Abbildung eines Steuerbetrages.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Steuerbetrag JSON Schema `_", + "description": "Abbildung eines Steuerbetrages.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Steuerbetrag JSON Schema `_", "title": "Steuerbetrag", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,12 +30,12 @@ ] }, "basiswert": { + "description": "Nettobetrag für den die Steuer berechnet wurde. Z.B. 100", "title": "Basiswert", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -41,6 +43,7 @@ ] }, "steuerkennzeichen": { + "description": "Kennzeichnung des Steuersatzes, bzw. Verfahrens.", "default": null, "anyOf": [ { @@ -52,12 +55,12 @@ ] }, "steuerwert": { + "description": "Aus dem Basiswert berechnete Steuer. Z.B. 19 (bei UST_19)", "title": "Steuerwert", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -65,6 +68,7 @@ ] }, "waehrung": { + "description": "Währung. Z.B. Euro.", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/Tarifberechnungsparameter.json b/unittests/test_data/bo4e_schemas/com/Tarifberechnungsparameter.json index bae39c2..fc9a3d9 100644 --- a/unittests/test_data/bo4e_schemas/com/Tarifberechnungsparameter.json +++ b/unittests/test_data/bo4e_schemas/com/Tarifberechnungsparameter.json @@ -1,9 +1,10 @@ { - "description": "In dieser Komponente sind die Berechnungsparameter für die Ermittlung der Tarifkosten zusammengefasst.\n.. raw:: html\n\n \n\n.. HINT::\n `Tarifberechnungsparameter JSON Schema `_", + "description": "In dieser Komponente sind die Berechnungsparameter für die Ermittlung der Tarifkosten zusammengefasst.\n.. raw:: html\n\n \n\n.. HINT::\n `Tarifberechnungsparameter JSON Schema `_", "title": "Tarifberechnungsparameter", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "berechnungsmethode": { + "description": "Gibt an, wie die Einzelpreise des Tarifes zu verarbeiten sind", "default": null, "anyOf": [ { @@ -39,6 +42,7 @@ ] }, "hoechstpreisHT": { + "description": "Höchstpreis für den Durchschnitts-Arbeitspreis HT", "default": null, "anyOf": [ { @@ -50,6 +54,7 @@ ] }, "hoechstpreisNT": { + "description": "Höchstpreis für den Durchschnitts-Arbeitspreis NT", "default": null, "anyOf": [ { @@ -61,6 +66,7 @@ ] }, "istMesspreisInGrundpreisEnthalten": { + "description": "True, falls der Messpreis im Grundpreis (GP) enthalten ist", "title": "Istmesspreisingrundpreisenthalten", "default": null, "anyOf": [ @@ -73,6 +79,7 @@ ] }, "istMesspreisZuBeruecksichtigen": { + "description": "True, falls bei der Bildung des Durchschnittspreises für die Höchst- und Mindestpreisbetrachtung der Messpreis mit\nberücksichtigt wird", "title": "Istmesspreiszuberuecksichtigen", "default": null, "anyOf": [ @@ -85,12 +92,12 @@ ] }, "kwInklusive": { + "description": "Im Preis bereits eingeschlossene Leistung (für Gas)", "title": "Kwinklusive", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -98,12 +105,12 @@ ] }, "kwWeitereMengen": { + "description": "Intervall, indem die über \"kwInklusive\" hinaus abgenommene Leistung kostenpflichtig wird (z.B. je 5 kW 20 EURO)", "title": "Kwweiteremengen", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -111,6 +118,7 @@ ] }, "messpreistyp": { + "description": "Typ des Messpreises", "default": null, "anyOf": [ { @@ -122,6 +130,7 @@ ] }, "mindestpreis": { + "description": "Mindestpreis für den Durchschnitts-Arbeitspreis", "default": null, "anyOf": [ { @@ -148,6 +157,7 @@ ] }, "zusatzpreise": { + "description": "Liste mit zusätzlichen Preisen, beispielsweise Messpreise und/oder Leistungspreise", "title": "Zusatzpreise", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/Tarifeinschraenkung.json b/unittests/test_data/bo4e_schemas/com/Tarifeinschraenkung.json index d58f7ec..68be4d3 100644 --- a/unittests/test_data/bo4e_schemas/com/Tarifeinschraenkung.json +++ b/unittests/test_data/bo4e_schemas/com/Tarifeinschraenkung.json @@ -1,9 +1,10 @@ { - "description": "Mit dieser Komponente werden Einschränkungen für die Anwendung von Tarifen modelliert.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Tarifeinschraenkung JSON Schema `_", + "description": "Mit dieser Komponente werden Einschränkungen für die Anwendung von Tarifen modelliert.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Tarifeinschraenkung JSON Schema `_", "title": "Tarifeinschraenkung", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "einschraenkungleistung": { + "description": "Die vereinbarte Leistung, die (näherungsweise) abgenommen wird.\nInsbesondere Gastarife können daran gebunden sein, dass die Leistung einer vereinbarten Höhe entspricht. ", "title": "Einschraenkungleistung", "default": null, "anyOf": [ @@ -43,6 +46,7 @@ ] }, "einschraenkungzaehler": { + "description": "Liste der Zähler/Geräte, die erforderlich sind, damit dieser Tarif zur Anwendung gelangen kann.\n(Falls keine Zähler angegeben sind, ist der Tarif nicht an das Vorhandensein bestimmter Zähler gebunden.) ", "title": "Einschraenkungzaehler", "default": null, "anyOf": [ @@ -58,6 +62,7 @@ ] }, "voraussetzungen": { + "description": "Voraussetzungen, die erfüllt sein müssen, damit dieser Tarif zur Anwendung kommen kann", "title": "Voraussetzungen", "default": null, "anyOf": [ @@ -88,6 +93,7 @@ ] }, "zusatzprodukte": { + "description": "Weitere Produkte, die gemeinsam mit diesem Tarif bestellt werden können", "title": "Zusatzprodukte", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/Tarifpreis.json b/unittests/test_data/bo4e_schemas/com/Tarifpreis.json index 354c44c..daf3906 100644 --- a/unittests/test_data/bo4e_schemas/com/Tarifpreis.json +++ b/unittests/test_data/bo4e_schemas/com/Tarifpreis.json @@ -1,9 +1,10 @@ { - "description": "Abbildung eines Tarifpreises mit Preistyp und Beschreibung abgeleitet von COM Preis.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Tarifpreis JSON Schema `_", + "description": "Abbildung eines Tarifpreises mit Preistyp und Beschreibung abgeleitet von COM Preis.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Tarifpreis JSON Schema `_", "title": "Tarifpreis", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "beschreibung": { + "description": "Beschreibung des Preises. Hier können z.B. Preisdetails angegeben sein, beispielsweise \"Drehstromzähler\".", "title": "Beschreibung", "default": null, "anyOf": [ @@ -40,6 +43,7 @@ ] }, "bezugswert": { + "description": "Angabe, für welche Bezugsgröße der Preis gilt. Z.B. kWh.", "default": null, "anyOf": [ { @@ -51,6 +55,7 @@ ] }, "einheit": { + "description": "Währungseinheit für den Preis, z.B. Euro oder Ct.", "default": null, "anyOf": [ { @@ -62,6 +67,7 @@ ] }, "preistyp": { + "description": "Angabe des Preistypes (z.B. Grundpreis)", "default": null, "anyOf": [ { @@ -73,6 +79,7 @@ ] }, "status": { + "description": "Gibt den Status des veröffentlichten Preises an", "default": null, "anyOf": [ { @@ -84,12 +91,12 @@ ] }, "wert": { + "description": "Gibt die nominale Höhe des Preises an.", "title": "Wert", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" diff --git a/unittests/test_data/bo4e_schemas/com/Tarifpreisposition.json b/unittests/test_data/bo4e_schemas/com/Tarifpreisposition.json index 012532c..b16f38d 100644 --- a/unittests/test_data/bo4e_schemas/com/Tarifpreisposition.json +++ b/unittests/test_data/bo4e_schemas/com/Tarifpreisposition.json @@ -1,9 +1,10 @@ { - "description": "Mit dieser Komponente können Tarifpreise verschiedener Typen abgebildet werden.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Tarifpreisposition JSON Schema `_", + "description": "Mit dieser Komponente können Tarifpreise verschiedener Typen abgebildet werden.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Tarifpreisposition JSON Schema `_", "title": "Tarifpreisposition", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "bezugseinheit": { + "description": "Größe, auf die sich die Einheit bezieht, beispielsweise kWh, Jahr", "default": null, "anyOf": [ { @@ -39,6 +42,7 @@ ] }, "einheit": { + "description": "Einheit des Preises (z.B. EURO)", "default": null, "anyOf": [ { @@ -50,6 +54,7 @@ ] }, "mengeneinheitstaffel": { + "description": "Gibt an, nach welcher Menge die vorgenannte Einschränkung erfolgt (z.B. Jahresstromverbrauch in kWh)", "default": null, "anyOf": [ { @@ -61,6 +66,7 @@ ] }, "preisstaffeln": { + "description": "Hier sind die Staffeln mit ihren Preisenangaben definiert", "title": "Preisstaffeln", "default": null, "anyOf": [ @@ -76,6 +82,7 @@ ] }, "preistyp": { + "description": "Angabe des Preistypes (z.B. Grundpreis)", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/TarifpreispositionProOrt.json b/unittests/test_data/bo4e_schemas/com/TarifpreispositionProOrt.json index 62f453d..9933b3d 100644 --- a/unittests/test_data/bo4e_schemas/com/TarifpreispositionProOrt.json +++ b/unittests/test_data/bo4e_schemas/com/TarifpreispositionProOrt.json @@ -1,9 +1,10 @@ { - "description": "Mit dieser Komponente können Tarifpreise verschiedener Typen abgebildet werden\n\n.. raw:: html\n\n \n\n.. HINT::\n `TarifpreispositionProOrt JSON Schema `_", + "description": "Mit dieser Komponente können Tarifpreise verschiedener Typen abgebildet werden\n\n.. raw:: html\n\n \n\n.. HINT::\n `TarifpreispositionProOrt JSON Schema `_", "title": "TarifpreispositionProOrt", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "netznr": { + "description": "ene't-Netznummer des Netzes in dem der Preis gilt", "title": "Netznr", "default": null, "anyOf": [ @@ -40,6 +43,7 @@ ] }, "ort": { + "description": "Ort für den der Preis gilt", "title": "Ort", "default": null, "anyOf": [ @@ -52,6 +56,7 @@ ] }, "postleitzahl": { + "description": "Postleitzahl des Ortes für den der Preis gilt", "title": "Postleitzahl", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/TarifpreisstaffelProOrt.json b/unittests/test_data/bo4e_schemas/com/TarifpreisstaffelProOrt.json index 0e8cc83..ab0d1ac 100644 --- a/unittests/test_data/bo4e_schemas/com/TarifpreisstaffelProOrt.json +++ b/unittests/test_data/bo4e_schemas/com/TarifpreisstaffelProOrt.json @@ -1,9 +1,10 @@ { - "description": "Gibt die Staffelgrenzen der jeweiligen Preise an\n\n.. raw:: html\n\n \n\n.. HINT::\n `TarifpreisstaffelProOrt JSON Schema `_", + "description": "Gibt die Staffelgrenzen der jeweiligen Preise an\n\n.. raw:: html\n\n \n\n.. HINT::\n `TarifpreisstaffelProOrt JSON Schema `_", "title": "TarifpreisstaffelProOrt", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,12 +30,12 @@ ] }, "arbeitspreis": { + "description": "Der Arbeitspreis in ct/kWh", "title": "Arbeitspreis", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -41,12 +43,12 @@ ] }, "arbeitspreisNT": { + "description": "Der Arbeitspreis für Verbräuche in der Niedertarifzeit in ct/kWh", "title": "Arbeitspreisnt", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -54,12 +56,12 @@ ] }, "grundpreis": { + "description": "Der Grundpreis in Euro/Jahr", "title": "Grundpreis", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -67,12 +69,12 @@ ] }, "staffelgrenzeBis": { + "description": "Oberer Wert, bis zu dem die Staffel gilt (exklusive)", "title": "Staffelgrenzebis", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -80,12 +82,12 @@ ] }, "staffelgrenzeVon": { + "description": "Unterer Wert, ab dem die Staffel gilt (inklusive)", "title": "Staffelgrenzevon", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" diff --git a/unittests/test_data/bo4e_schemas/com/Unterschrift.json b/unittests/test_data/bo4e_schemas/com/Unterschrift.json index f69a80d..6632eec 100644 --- a/unittests/test_data/bo4e_schemas/com/Unterschrift.json +++ b/unittests/test_data/bo4e_schemas/com/Unterschrift.json @@ -1,9 +1,10 @@ { - "description": "Modellierung einer Unterschrift, z.B. für Verträge, Angebote etc.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Unterschrift JSON Schema `_", + "description": "Modellierung einer Unterschrift, z.B. für Verträge, Angebote etc.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Unterschrift JSON Schema `_", "title": "Unterschrift", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "datum": { + "description": "Ort, an dem die Unterschrift geleistet wird", "title": "Datum", "default": null, "anyOf": [ @@ -41,6 +44,7 @@ ] }, "name": { + "description": "Name des Unterschreibers", "title": "Name", "default": null, "anyOf": [ @@ -53,6 +57,7 @@ ] }, "ort": { + "description": "Ort, an dem die Unterschrift geleistet wird", "title": "Ort", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/Verbrauch.json b/unittests/test_data/bo4e_schemas/com/Verbrauch.json index e4d7b18..54e2ee5 100644 --- a/unittests/test_data/bo4e_schemas/com/Verbrauch.json +++ b/unittests/test_data/bo4e_schemas/com/Verbrauch.json @@ -1,9 +1,10 @@ { - "description": "Abbildung eines zeitlich abgegrenzten Verbrauchs\n\n.. raw:: html\n\n \n\n.. HINT::\n `Verbrauch JSON Schema `_", + "description": "Abbildung eines zeitlich abgegrenzten Verbrauchs\n\n.. raw:: html\n\n \n\n.. HINT::\n `Verbrauch JSON Schema `_", "title": "Verbrauch", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "einheit": { + "description": "Gibt die Einheit zum jeweiligen Wert an", "default": null, "anyOf": [ { @@ -39,6 +42,7 @@ ] }, "enddatum": { + "description": "Exklusives Ende des Zeitraumes, für den der Verbrauch angegeben wird", "title": "Enddatum", "default": null, "anyOf": [ @@ -52,6 +56,7 @@ ] }, "messwertstatus": { + "description": "Messwertstatus includes the plausibility of the value", "default": null, "anyOf": [ { @@ -63,6 +68,7 @@ ] }, "obisKennzahl": { + "description": "Die OBIS-Kennzahl für den Wert, die festlegt, welche Größe mit dem Stand gemeldet wird, z.B. '1-0:", "title": "Obiskennzahl", "default": null, "anyOf": [ @@ -75,6 +81,7 @@ ] }, "startdatum": { + "description": "Inklusiver Beginn des Zeitraumes, für den der Verbrauch angegeben wird", "title": "Startdatum", "default": null, "anyOf": [ @@ -88,12 +95,12 @@ ] }, "wert": { + "description": "Gibt den absoluten Wert der Menge an", "title": "Wert", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -101,6 +108,7 @@ ] }, "wertermittlungsverfahren": { + "description": "Gibt an, ob es sich um eine PROGNOSE oder eine MESSUNG handelt", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/Vertragskonditionen.json b/unittests/test_data/bo4e_schemas/com/Vertragskonditionen.json index 655912d..291d698 100644 --- a/unittests/test_data/bo4e_schemas/com/Vertragskonditionen.json +++ b/unittests/test_data/bo4e_schemas/com/Vertragskonditionen.json @@ -1,9 +1,10 @@ { - "description": "Abbildung für Vertragskonditionen. Die Komponente wird sowohl im Vertrag als auch im Tarif verwendet.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Vertragskonditionen JSON Schema `_", + "description": "Abbildung für Vertragskonditionen. Die Komponente wird sowohl im Vertrag als auch im Tarif verwendet.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Vertragskonditionen JSON Schema `_", "title": "Vertragskonditionen", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "abschlagszyklus": { + "description": "In diesen Zyklen werden Abschläge gestellt. Alternativ kann auch die Anzahl in den Konditionen angeben werden.", "default": null, "anyOf": [ { @@ -39,12 +42,12 @@ ] }, "anzahlAbschlaege": { + "description": "Anzahl der vereinbarten Abschläge pro Jahr, z.B. 12", "title": "Anzahlabschlaege", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -52,6 +55,7 @@ ] }, "beschreibung": { + "description": "Freitext zur Beschreibung der Konditionen, z.B. \"Standardkonditionen Gas\"", "title": "Beschreibung", "default": null, "anyOf": [ @@ -64,6 +68,7 @@ ] }, "kuendigungsfrist": { + "description": "Innerhalb dieser Frist kann der Vertrag gekündigt werden", "default": null, "anyOf": [ { @@ -75,6 +80,7 @@ ] }, "vertragslaufzeit": { + "description": "Über diesen Zeitraum läuft der Vertrag", "default": null, "anyOf": [ { @@ -86,6 +92,7 @@ ] }, "vertragsverlaengerung": { + "description": "Falls der Vertrag nicht gekündigt wird, verlängert er sich automatisch um die hier angegebene Zeit", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/Vertragsteil.json b/unittests/test_data/bo4e_schemas/com/Vertragsteil.json index 2714bdd..c2dd290 100644 --- a/unittests/test_data/bo4e_schemas/com/Vertragsteil.json +++ b/unittests/test_data/bo4e_schemas/com/Vertragsteil.json @@ -1,9 +1,10 @@ { - "description": "Abbildung für einen Vertragsteil. Der Vertragsteil wird dazu verwendet,\neine vertragliche Leistung in Bezug zu einer Lokation (Markt- oder Messlokation) festzulegen.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Vertragsteil JSON Schema `_", + "description": "Abbildung für einen Vertragsteil. Der Vertragsteil wird dazu verwendet,\neine vertragliche Leistung in Bezug zu einer Lokation (Markt- oder Messlokation) festzulegen.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Vertragsteil JSON Schema `_", "title": "Vertragsteil", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "lokation": { + "description": "Der Identifier für diejenigen Markt- oder Messlokation, die zu diesem Vertragsteil gehören.\nVerträge für mehrere Lokationen werden mit mehreren Vertragsteilen abgebildet", "title": "Lokation", "default": null, "anyOf": [ @@ -40,6 +43,7 @@ ] }, "maximaleAbnahmemenge": { + "description": "Für die Lokation festgelegte maximale Abnahmemenge (exklusiv)", "default": null, "anyOf": [ { @@ -51,6 +55,7 @@ ] }, "minimaleAbnahmemenge": { + "description": "Für die Lokation festgelegte Mindestabnahmemenge (inklusiv)", "default": null, "anyOf": [ { @@ -62,6 +67,7 @@ ] }, "vertraglichFixierteMenge": { + "description": "Für die Lokation festgeschriebene Abnahmemenge", "default": null, "anyOf": [ { @@ -73,6 +79,7 @@ ] }, "vertragsteilbeginn": { + "description": "Start der Gültigkeit des Vertragsteils (inklusiv)", "title": "Vertragsteilbeginn", "default": null, "anyOf": [ @@ -86,6 +93,7 @@ ] }, "vertragsteilende": { + "description": "Ende der Gültigkeit des Vertragsteils (exklusiv)", "title": "Vertragsteilende", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/VerwendungszweckProMarktrolle.json b/unittests/test_data/bo4e_schemas/com/VerwendungszweckProMarktrolle.json index 3b339a7..c1d56cf 100644 --- a/unittests/test_data/bo4e_schemas/com/VerwendungszweckProMarktrolle.json +++ b/unittests/test_data/bo4e_schemas/com/VerwendungszweckProMarktrolle.json @@ -1,9 +1,10 @@ { - "description": "Dient zur Identifizierung des Verwendungszwecks der Marktrolle an der Marktlokation, der die Werte zu übermitteln sind.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Verwendungszweck JSON Schema `_", + "description": "Dient zur Identifizierung des Verwendungszwecks der Marktrolle an der Marktlokation, der die Werte zu übermitteln sind.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Verwendungszweck JSON Schema `_", "title": "VerwendungszweckProMarktrolle", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "marktrolle": { + "description": "Marktrolle, für die die Daten relevant sind", "default": null, "anyOf": [ { @@ -54,6 +57,7 @@ ] }, "zwecke": { + "description": "Verwendungszwecke", "title": "Zwecke", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/Zaehlwerk.json b/unittests/test_data/bo4e_schemas/com/Zaehlwerk.json index 08cc0e3..ff671c4 100644 --- a/unittests/test_data/bo4e_schemas/com/Zaehlwerk.json +++ b/unittests/test_data/bo4e_schemas/com/Zaehlwerk.json @@ -1,9 +1,10 @@ { - "description": "Mit dieser Komponente werden Zählwerke modelliert.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Zaehlwerk JSON Schema `_", + "description": "Mit dieser Komponente werden Zählwerke modelliert.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Zaehlwerk JSON Schema `_", "title": "Zaehlwerk", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "anzahlAblesungen": { + "description": "Abrechnungsrelevant", "title": "Anzahlablesungen", "default": null, "anyOf": [ @@ -63,6 +66,7 @@ ] }, "istAbrechnungsrelevant": { + "description": "Anzahl der Nachkommastellen", "title": "Istabrechnungsrelevant", "default": null, "anyOf": [ @@ -75,6 +79,7 @@ ] }, "istSchwachlastfaehig": { + "description": "Schwachlastfaehigkeit", "title": "Istschwachlastfaehig", "default": null, "anyOf": [ @@ -87,6 +92,7 @@ ] }, "istSteuerbefreit": { + "description": "Konzessionsabgabe", "title": "Iststeuerbefreit", "default": null, "anyOf": [ @@ -99,6 +105,7 @@ ] }, "istUnterbrechbar": { + "description": "Stromverbrauchsart/Verbrauchsart Marktlokation", "title": "Istunterbrechbar", "default": null, "anyOf": [ @@ -111,6 +118,7 @@ ] }, "konzessionsabgabe": { + "description": "Wärmenutzung Marktlokation", "default": null, "anyOf": [ { @@ -122,6 +130,7 @@ ] }, "nachkommastelle": { + "description": "Anzahl der Vorkommastellen", "title": "Nachkommastelle", "default": null, "anyOf": [ @@ -157,6 +166,7 @@ ] }, "verbrauchsart": { + "description": "Stromverbrauchsart/Verbrauchsart Marktlokation", "default": null, "anyOf": [ { @@ -168,6 +178,7 @@ ] }, "verwendungszwecke": { + "description": "Schwachlastfaehigkeit", "title": "Verwendungszwecke", "default": null, "anyOf": [ @@ -183,6 +194,7 @@ ] }, "vorkommastelle": { + "description": "Steuerbefreiung", "title": "Vorkommastelle", "default": null, "anyOf": [ @@ -195,6 +207,7 @@ ] }, "waermenutzung": { + "description": "Unterbrechbarkeit Marktlokation", "default": null, "anyOf": [ { @@ -210,8 +223,7 @@ "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -231,6 +243,7 @@ ] }, "zaehlzeitregister": { + "description": "Anzahl Ablesungen pro Jahr", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/Zaehlzeitregister.json b/unittests/test_data/bo4e_schemas/com/Zaehlzeitregister.json index b9ffe71..6a037ad 100644 --- a/unittests/test_data/bo4e_schemas/com/Zaehlzeitregister.json +++ b/unittests/test_data/bo4e_schemas/com/Zaehlzeitregister.json @@ -1,9 +1,10 @@ { - "description": "Mit dieser Komponente werden Zählzeitregister modelliert. Ein Zählzeitregister beschreibt eine erweiterte Definition der Zählzeit\nin Bezug auf ein Register. Dabei werden alle Codes dazu vom Netzbetreiber vergeben.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Zaehlzeitregister JSON Schema `_", + "description": "Mit dieser Komponente werden Zählzeitregister modelliert. Ein Zählzeitregister beschreibt eine erweiterte Definition der Zählzeit\nin Bezug auf ein Register. Dabei werden alle Codes dazu vom Netzbetreiber vergeben.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Zaehlzeitregister JSON Schema `_", "title": "Zaehlzeitregister", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "istSchwachlastfaehig": { + "description": "Zählzeitregister", "title": "Istschwachlastfaehig", "default": null, "anyOf": [ @@ -40,6 +43,7 @@ ] }, "zaehlzeitDefinition": { + "description": "Zählzeitdefinition", "title": "Zaehlzeitdefinition", "default": null, "anyOf": [ @@ -52,6 +56,7 @@ ] }, "zaehlzeitRegister": { + "description": "Zählzeitdefinition", "title": "Zaehlzeitregister", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/Zeitraum.json b/unittests/test_data/bo4e_schemas/com/Zeitraum.json index 755c8d0..7e5f4d2 100644 --- a/unittests/test_data/bo4e_schemas/com/Zeitraum.json +++ b/unittests/test_data/bo4e_schemas/com/Zeitraum.json @@ -1,9 +1,10 @@ { - "description": "Diese Komponente wird zur Abbildung von Zeiträumen in Form von Dauern oder der Angabe von Start und Ende verwendet.\nEs muss daher eine der drei Möglichkeiten angegeben sein:\n- Einheit und Dauer oder\n- Zeitraum: Startdatum bis Enddatum oder\n- Zeitraum: Startzeitpunkt (Datum und Uhrzeit) bis Endzeitpunkt (Datum und Uhrzeit)\n\n.. raw:: html\n\n \n\n.. HINT::\n `Zeitraum JSON Schema `_", + "description": "Diese Komponente wird zur Abbildung von Zeiträumen in Form von Dauern oder der Angabe von Start und Ende verwendet.\nEs muss daher eine der drei Möglichkeiten angegeben sein:\n- Einheit und Dauer oder\n- Zeitraum: Startdatum bis Enddatum oder\n- Zeitraum: Startzeitpunkt (Datum und Uhrzeit) bis Endzeitpunkt (Datum und Uhrzeit)\n\n.. raw:: html\n\n \n\n.. HINT::\n `Zeitraum JSON Schema `_", "title": "Zeitraum", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -32,8 +34,7 @@ "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" diff --git a/unittests/test_data/bo4e_schemas/com/Zeitreihenwert.json b/unittests/test_data/bo4e_schemas/com/Zeitreihenwert.json index d4b9e22..1c208a1 100644 --- a/unittests/test_data/bo4e_schemas/com/Zeitreihenwert.json +++ b/unittests/test_data/bo4e_schemas/com/Zeitreihenwert.json @@ -1,9 +1,10 @@ { - "description": "Abbildung eines Zeitreihenwertes bestehend aus Zeitraum, Wert und Statusinformationen.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Zeitreihenwert JSON Schema `_", + "description": "Abbildung eines Zeitreihenwertes bestehend aus Zeitraum, Wert und Statusinformationen.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Zeitreihenwert JSON Schema `_", "title": "Zeitreihenwert", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "status": { + "description": "Der Status gibt an, wie der Wert zu interpretieren ist, z.B. in Berechnungen.", "default": null, "anyOf": [ { @@ -39,6 +42,7 @@ ] }, "statuszusatz": { + "description": "Eine Zusatzinformation zum Status, beispielsweise ein Grund für einen fehlenden Wert.", "default": null, "anyOf": [ { @@ -50,12 +54,12 @@ ] }, "wert": { + "description": "Zeitespanne für das Messintervall", "title": "Wert", "default": null, "anyOf": [ { - "type": "string", - "format": "decimal" + "type": "number" }, { "type": "null" @@ -63,6 +67,7 @@ ] }, "zeitspanne": { + "description": "Zeitespanne für das Messintervall", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/com/Zeitspanne.json b/unittests/test_data/bo4e_schemas/com/Zeitspanne.json index 40e427c..7095605 100644 --- a/unittests/test_data/bo4e_schemas/com/Zeitspanne.json +++ b/unittests/test_data/bo4e_schemas/com/Zeitspanne.json @@ -1,9 +1,10 @@ { - "description": "Eine Zeitspanne ist definiert aus Start und/oder Ende.\nDer Unterschied zur Menge (die auch zur Abbildung von Zeitmengen genutzt wird) ist, dass konkrete Start- und Endzeitpunkte angegeben werden.\nDie Zeitspanne ist aus dem COM Zeitraum hervorgegangen, das in Zeitspanne und Menge aufgeteilt wurde.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Zeitspanne JSON Schema `_", + "description": "Eine Zeitspanne ist definiert aus Start und/oder Ende.\nDer Unterschied zur Menge (die auch zur Abbildung von Zeitmengen genutzt wird) ist, dass konkrete Start- und Endzeitpunkte angegeben werden.\nDie Zeitspanne ist aus dem COM Zeitraum hervorgegangen, das in Zeitspanne und Menge aufgeteilt wurde.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Zeitspanne JSON Schema `_", "title": "Zeitspanne", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "ende": { + "description": "inklusiver Beginn", "title": "Ende", "default": null, "anyOf": [ @@ -41,6 +44,7 @@ ] }, "start": { + "description": "inklusiver Beginn", "title": "Start", "default": null, "anyOf": [ diff --git a/unittests/test_data/bo4e_schemas/com/Zustaendigkeit.json b/unittests/test_data/bo4e_schemas/com/Zustaendigkeit.json index 851ec84..21c64d8 100644 --- a/unittests/test_data/bo4e_schemas/com/Zustaendigkeit.json +++ b/unittests/test_data/bo4e_schemas/com/Zustaendigkeit.json @@ -1,9 +1,10 @@ { - "description": "Enthält die zeitliche Zuordnung eines Ansprechpartners zu Abteilungen und Zuständigkeiten.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Zustaendigkeit JSON Schema `_", + "description": "Enthält die zeitliche Zuordnung eines Ansprechpartners zu Abteilungen und Zuständigkeiten.\n\n.. raw:: html\n\n \n\n.. HINT::\n `Zustaendigkeit JSON Schema `_", "title": "Zustaendigkeit", "additionalProperties": true, "properties": { "_id": { + "description": "Eine generische ID, die für eigene Zwecke genutzt werden kann.\nZ.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.", "title": " Id", "default": null, "anyOf": [ @@ -16,8 +17,9 @@ ] }, "_version": { + "description": "Version der BO-Struktur aka \"fachliche Versionierung\"", "title": " Version", - "default": "v202401.0.1", + "default": "v202401.3.2", "anyOf": [ { "type": "string" @@ -28,6 +30,7 @@ ] }, "abteilung": { + "description": "Berufliche Rolle des Ansprechpartners/ der Person", "title": "Abteilung", "default": null, "anyOf": [ @@ -39,8 +42,9 @@ } ] }, - "jobtitel": { - "title": "Jobtitel", + "position": { + "description": "Berufliche Rolle des Ansprechpartners/ der Person", + "title": "Position", "default": null, "anyOf": [ { @@ -52,6 +56,7 @@ ] }, "themengebiet": { + "description": "Hier kann eine thematische Zuordnung des Ansprechpartners bzw. der Person angegeben werden", "default": null, "anyOf": [ { diff --git a/unittests/test_data/bo4e_schemas/enum/EMobilitaetsart.json b/unittests/test_data/bo4e_schemas/enum/EMobilitaetsart.json new file mode 100644 index 0000000..51daa32 --- /dev/null +++ b/unittests/test_data/bo4e_schemas/enum/EMobilitaetsart.json @@ -0,0 +1,10 @@ +{ + "description": "Art der E-Mobilität", + "title": "EMobilitaetsart", + "enum": [ + "WALLBOX", + "E_MOBILITAETSLADESAEULE", + "LADEPARK" + ], + "type": "string" +} diff --git a/unittests/test_data/bo4e_schemas/enum/Kontaktart.json b/unittests/test_data/bo4e_schemas/enum/Kontaktart.json index 313dfd9..fccfe72 100644 --- a/unittests/test_data/bo4e_schemas/enum/Kontaktart.json +++ b/unittests/test_data/bo4e_schemas/enum/Kontaktart.json @@ -1,9 +1,9 @@ { - "description": "Art des Kontaktes zwischen Geschäftspartnern.", + "description": "Gibt an, auf welchem Weg die Person oder der Geschäftspartner kontaktiert werden kann.", "title": "Kontaktart", "enum": [ - "ANSCHREIBEN", - "TELEFONAT", + "POSTWEG", + "TELEFON", "FAX", "E_MAIL", "SMS" diff --git a/unittests/test_data/bo4e_schemas/enum/Lokationstyp.json b/unittests/test_data/bo4e_schemas/enum/Lokationstyp.json index 438ad75..dfcc59c 100644 --- a/unittests/test_data/bo4e_schemas/enum/Lokationstyp.json +++ b/unittests/test_data/bo4e_schemas/enum/Lokationstyp.json @@ -3,7 +3,10 @@ "title": "Lokationstyp", "enum": [ "MALO", - "MELO" + "MELO", + "NELO", + "SR", + "TR" ], "type": "string" } diff --git a/unittests/test_data/bo4e_schemas/enum/Marktrolle.json b/unittests/test_data/bo4e_schemas/enum/Marktrolle.json index 84680a8..0c9d6b2 100644 --- a/unittests/test_data/bo4e_schemas/enum/Marktrolle.json +++ b/unittests/test_data/bo4e_schemas/enum/Marktrolle.json @@ -2,20 +2,19 @@ "description": "Diese Rollen kann ein Marktteilnehmer einnehmen.", "title": "Marktrolle", "enum": [ - "NB", - "LF", - "MSB", - "DL", + "BTR", + "BIKO", "BKV", - "BKO", - "UENB", - "KUNDE_SELBST_NN", - "MGV", + "DP", "EIV", + "ESA", + "KN", + "LF", + "MGV", + "MSB", + "NB", "RB", - "KUNDE", - "INTERESSENT", - "BTR" + "UENB" ], "type": "string" } diff --git a/unittests/test_data/bo4e_schemas/enum/Mengeneinheit.json b/unittests/test_data/bo4e_schemas/enum/Mengeneinheit.json index fd9f973..d54fce3 100644 --- a/unittests/test_data/bo4e_schemas/enum/Mengeneinheit.json +++ b/unittests/test_data/bo4e_schemas/enum/Mengeneinheit.json @@ -22,7 +22,10 @@ "HALBJAHR", "JAHR", "PROZENT", - "KVAR" + "KVAR", + "KWHK", + "VAR", + "VARH" ], "type": "string" } diff --git a/unittests/test_data/bo4e_schemas/enum/Organisationstyp.json b/unittests/test_data/bo4e_schemas/enum/Organisationstyp.json new file mode 100644 index 0000000..ea21321 --- /dev/null +++ b/unittests/test_data/bo4e_schemas/enum/Organisationstyp.json @@ -0,0 +1,11 @@ +{ + "description": "Hier wird festgelegt, ob der Geschäftspartner eine Person, eine Firma oder etwas anderes ist.", + "title": "Organisationstyp", + "enum": [ + "PRIVATPERSON", + "UNTERNEHMEN", + "KOMMUNALE_EINRICHTUNG", + "STAATLICHE_BEHOERDE" + ], + "type": "string" +} diff --git a/unittests/test_data/bo4e_schemas/enum/Rufnummernart.json b/unittests/test_data/bo4e_schemas/enum/Rufnummernart.json deleted file mode 100644 index 4c9f51f..0000000 --- a/unittests/test_data/bo4e_schemas/enum/Rufnummernart.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "description": "Abbildung verschiedener Rufnummerntypen.", - "title": "Rufnummernart", - "enum": [ - "RUF_ZENTRALE", - "FAX_ZENTRALE", - "SAMMELRUF", - "SAMMELFAX", - "ABTEILUNGRUF", - "ABTEILUNGFAX", - "RUF_DURCHWAHL", - "FAX_DURCHWAHL", - "MOBIL_NUMMER" - ], - "type": "string" -} diff --git a/unittests/test_data/bo4e_schemas/enum/Speicherart.json b/unittests/test_data/bo4e_schemas/enum/Speicherart.json new file mode 100644 index 0000000..85e0412 --- /dev/null +++ b/unittests/test_data/bo4e_schemas/enum/Speicherart.json @@ -0,0 +1,11 @@ +{ + "description": "Art der Speicherung", + "title": "Speicherart", + "enum": [ + "WASSERSTOFFSPEICHER", + "PUMPSPEICHER", + "BATTERIESPEICHER", + "SONSTIGE_SPEICHERART" + ], + "type": "string" +} diff --git a/unittests/test_data/bo4e_schemas/enum/SteuerkanalLeistungsbeschreibung.json b/unittests/test_data/bo4e_schemas/enum/SteuerkanalLeistungsbeschreibung.json new file mode 100644 index 0000000..05a3a38 --- /dev/null +++ b/unittests/test_data/bo4e_schemas/enum/SteuerkanalLeistungsbeschreibung.json @@ -0,0 +1,9 @@ +{ + "description": "Beschreibung des Steuerkanals", + "title": "SteuerkanalLeistungsbeschreibung", + "enum": [ + "AN_AUS", + "GESTUFT" + ], + "type": "string" +} diff --git a/unittests/test_data/bo4e_schemas/enum/TechnischeRessourceNutzung.json b/unittests/test_data/bo4e_schemas/enum/TechnischeRessourceNutzung.json new file mode 100644 index 0000000..5a73107 --- /dev/null +++ b/unittests/test_data/bo4e_schemas/enum/TechnischeRessourceNutzung.json @@ -0,0 +1,10 @@ +{ + "description": "Nutzung der technischen Ressource", + "title": "TechnischeRessourceNutzung", + "enum": [ + "STROMVERBRAUCHSART", + "STROMERZEUGUNGSART", + "SPEICHER" + ], + "type": "string" +} diff --git a/unittests/test_data/bo4e_schemas/enum/TechnischeRessourceVerbrauchsart.json b/unittests/test_data/bo4e_schemas/enum/TechnischeRessourceVerbrauchsart.json new file mode 100644 index 0000000..f7a3ce2 --- /dev/null +++ b/unittests/test_data/bo4e_schemas/enum/TechnischeRessourceVerbrauchsart.json @@ -0,0 +1,11 @@ +{ + "description": "Verbrauchsart der technischen Ressource", + "title": "TechnischeRessourceVerbrauchsart", + "enum": [ + "KRAFT_LICHT", + "WAERME", + "E_MOBILITAET", + "STRASSENBELEUCHTUNG" + ], + "type": "string" +} diff --git a/unittests/test_data/bo4e_schemas/enum/Themengebiet.json b/unittests/test_data/bo4e_schemas/enum/Themengebiet.json index e403bd2..f4e6286 100644 --- a/unittests/test_data/bo4e_schemas/enum/Themengebiet.json +++ b/unittests/test_data/bo4e_schemas/enum/Themengebiet.json @@ -60,7 +60,9 @@ "WIM", "ZAEHLERSTAENDE_SLP", "ZAHLUNGSVERKEHR", - "ZUORDNUNGSVEREINBARUNG" + "ZUORDNUNGSVEREINBARUNG", + "EINSPEISUNG", + "BEWEGUNGSDATEN" ], "type": "string" } diff --git a/unittests/test_data/bo4e_schemas/enum/Typ.json b/unittests/test_data/bo4e_schemas/enum/Typ.json index cc8ce32..487b417 100644 --- a/unittests/test_data/bo4e_schemas/enum/Typ.json +++ b/unittests/test_data/bo4e_schemas/enum/Typ.json @@ -3,7 +3,6 @@ "title": "Typ", "enum": [ "ANGEBOT", - "ANSPRECHPARTNER", "AUSSCHREIBUNG", "BUENDELVERTRAG", "ENERGIEMENGE", @@ -15,8 +14,12 @@ "LASTGANG", "MARKTLOKATION", "MESSLOKATION", + "NETZLOKATION", "MARKTTEILNEHMER", "NETZNUTZUNGSRECHNUNG", + "TECHNISCHERESSOURCE", + "STEUERBARERESSOURCE", + "PERSON", "PREISBLATT", "PREISBLATTDIENSTLEISTUNG", "PREISBLATTHARDWARE", @@ -34,7 +37,8 @@ "TARIFPREISBLATT", "VERTRAG", "ZAEHLER", - "ZEITREIHE" + "ZEITREIHE", + "LOKATIONSZUORDNUNG" ], "type": "string" } diff --git a/unittests/test_main.py b/unittests/test_main.py index f963307..7b42068 100644 --- a/unittests/test_main.py +++ b/unittests/test_main.py @@ -34,7 +34,6 @@ def test_main(self): ), f"{result.exc_info[0].__name__}: {result.exc_info[1]}\n{''.join(format_tb(result.exc_info[2]))}" assert (OUTPUT_DIR / "bo" / "angebot.py").exists() assert (OUTPUT_DIR / "bo" / "preisblatt_netznutzung.py").exists() - assert (OUTPUT_DIR / "com" / "com.py").exists() assert (OUTPUT_DIR / "enum" / "typ.py").exists() # pylint: disable=import-outside-toplevel, import-error @@ -43,6 +42,7 @@ def test_main(self): assert issubclass(Angebot, BaseModel) assert "typ" in Angebot.model_fields assert "datetime.datetime" in str(Angebot.model_fields["angebotsdatum"].annotation) + assert isinstance(Angebot(), Angebot) from .output.bo4e import __version__ # type: ignore[import-not-found] diff --git a/unittests/test_parser.py b/unittests/test_parser.py index 560c8e7..d483dbc 100644 --- a/unittests/test_parser.py +++ b/unittests/test_parser.py @@ -50,7 +50,7 @@ def test_bo4e_init_file_content(self) -> None: def test_remove_future_import(self) -> None: assert ("") == remove_future_import("from __future__ import annotations\n\n") - def test_parse_boe4_schemas(self) -> None: + def test_parse_bo4e_schemas(self) -> None: os.chdir(BASE_DIR) namespace = get_namespace(INPUT_DIR) input_directory = INPUT_DIR.resolve() diff --git a/unittests/test_schema.py b/unittests/test_schema.py index 0e90618..1e4cd23 100644 --- a/unittests/test_schema.py +++ b/unittests/test_schema.py @@ -23,4 +23,4 @@ def test_get_version(self) -> None: os.chdir(BASE_DIR) namespace = get_namespace(INPUT_DIR) version = get_version(None, namespace) - assert version == "v202401.0.1" + assert version == "v202401.3.2"