Merge branch 'develop' into fix/pagination

Author: s-heppner

.github/workflows/ci.yml

@@ -203,36 +203,37 @@ jobs:
         chmod +x ./etc/scripts/set_copyright_year.sh
         ./etc/scripts/set_copyright_year.sh --check
 
+# Todo: reset when the compliance-tool was updated (#485)
 
-  compliance-tool-test:
-    # This job runs the unittests on the python versions specified down at the matrix
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ["3.10", "3.12"]
-    defaults:
-      run:
-        working-directory: ./compliance_tool
-
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install Python dependencies
-      # install the local sdk in editable mode so it does not get overwritten
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install ../sdk
-        python -m pip install .[dev]
-    - name: Test with coverage + unittest
-      run: |
-        python -m coverage run --source=aas_compliance_tool -m unittest
-    - name: Report test coverage
-      if: ${{ always() }}
-      run: |
-        python -m coverage report -m
+#  compliance-tool-test:
+#    # This job runs the unittests on the python versions specified down at the matrix
+#    runs-on: ubuntu-latest
+#    strategy:
+#      matrix:
+#        python-version: ["3.10", "3.12"]
+#    defaults:
+#      run:
+#        working-directory: ./compliance_tool
+#
+#    steps:
+#    - uses: actions/checkout@v4
+#    - name: Set up Python ${{ matrix.python-version }}
+#      uses: actions/setup-python@v5
+#      with:
+#        python-version: ${{ matrix.python-version }}
+#    - name: Install Python dependencies
+#      # install the local sdk in editable mode so it does not get overwritten
+#      run: |
+#        python -m pip install --upgrade pip
+#        python -m pip install ../sdk
+#        python -m pip install .[dev]
+#    - name: Test with coverage + unittest
+#      run: |
+#        python -m coverage run --source=aas_compliance_tool -m unittest
+#    - name: Report test coverage
+#      if: ${{ always() }}
+#      run: |
+#        python -m coverage report -m
 
   compliance-tool-static-analysis:
     # This job runs static code analysis, namely pycodestyle and mypy

README.md

@@ -7,13 +7,13 @@ for Industry 4.0 Systems.
 
 These are the implemented AAS specifications of the [current SDK release](https://github.com/eclipse-basyx/basyx-python-sdk/releases/latest), which can be also found on [PyPI](https://pypi.org/project/basyx-python-sdk/):
 
-| Specification                         | Version                                                                                                                                                                           |
-|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Part 1: Metamodel                     | [v3.0.1 (01001)](https://industrialdigitaltwin.org/wp-content/uploads/2024/06/IDTA-01001-3-0-1_SpecificationAssetAdministrationShell_Part1_Metamodel.pdf)                   |
-| Schemata (JSONSchema, XSD)            | [v3.0.8 (IDTA-01001-3-0-1_schemasV3.0.8)](https://github.com/admin-shell-io/aas-specs/releases/tag/IDTA-01001-3-0-1_schemasV3.0.8)                                                |
-| Part 2: API                           | [v3.1.1 (01002)](https://industrialdigitaltwin.org/en/wp-content/uploads/sites/2/2025/08/IDTA-01002-3-1-1_AAS-Specification_Part2_API.pdf)                        |
+| Specification                         | Version                                                                                                                                            |
+|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
+| Part 1: Metamodel                     | [v3.1.2 (01001-3-1-2)](https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1.2/index.html)                                           |
+| Schemata (JSONSchema, XSD)            | [v3.1.2 (IDTA-01001-3-1-2)](https://github.com/admin-shell-io/aas-specs-metamodel/releases/tag/v3.1.2)                                             |
+| Part 2: API                           | [v3.1.1 (01002)](https://industrialdigitaltwin.org/en/wp-content/uploads/sites/2/2025/08/IDTA-01002-3-1-1_AAS-Specification_Part2_API.pdf)         |
 | Part 3a: Data Specification IEC 61360 | [v3.1.1 (01003-a)](https://industrialdigitaltwin.org/wp-content/uploads/2025/08/IDTA-01003-a-3-1-1_AAS-Specification_Part3a_DataSpecification.pdf) |
-| Part 5: Package File Format (AASX)    | [v3.1 (01005)](https://industrialdigitaltwin.org/wp-content/uploads/2025/06/IDTA_01005-25-01_AAS-Specification_Part5_AASXPackageFileFormat.pdf)                               |
+| Part 5: Package File Format (AASX)    | [v3.1 (01005)](https://industrialdigitaltwin.org/wp-content/uploads/2025/06/IDTA_01005-25-01_AAS-Specification_Part5_AASXPackageFileFormat.pdf)    |
 
 
 If you need support to an older version of the specifications, please refer to our [prior releases](https://github.com/eclipse-basyx/basyx-python-sdk/releases). 

compliance_tool/aas_compliance_tool/cli.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2025 the Eclipse BaSyx Authors
+# Copyright (c) 2026 the Eclipse BaSyx Authors
 #
 # This program and the accompanying materials are made available under the terms of the MIT License, available in
 # the LICENSE file of this project.
@@ -76,7 +76,7 @@ def parse_cli_arguments() -> argparse.ArgumentParser:
     parser.add_argument('-v', '--verbose', help="Print detailed information for each check. Multiple -v options "
                                                 "increase the verbosity. 1: Detailed error information, 2: Additional "
                                                 "detailed success information", action='count', default=0)
-    parser.add_argument('-q', '--quite', help="no information output if successful", action='store_true')
+    parser.add_argument('-q', '--quiet', help="no information output if successful", action='store_true')
     group = parser.add_mutually_exclusive_group(required=True)
     group.add_argument('--json', help="Use AAS json format when checking or creating files", action='store_true')
     group.add_argument('--xml', help="Use AAS xml format when checking or creating files", action='store_true')
@@ -177,9 +177,8 @@ def main():
                                                                 **data_checker_kwargs)
         else:
             parser.error("f or files requires two file path.")
-            exit()
 
-    if manager.status is Status.SUCCESS and args.quite:
+    if manager.status is Status.SUCCESS and args.quiet:
         exit()
 
     print(manager.format_state_manager(args.verbose))

compliance_tool/test/test_aas_compliance_tool.py

@@ -115,11 +115,17 @@ def test_parse_args(self) -> None:
         self.assertNotIn('ERROR', str(output.stderr))
         self.assertIn('INFO', str(output.stdout))
 
-        # test quite
+        # test quiet (short form)
         output = _run_compliance_tool("e", os.path.join(test_file_path, "test_demo_full_example.json"), "--json", "-q")
         self.assertEqual(0, output.returncode)
         self.assertEqual("b''", str(output.stdout))
 
+        # test quiet (long form -- previously misspelled as --quite)
+        output = _run_compliance_tool("e", os.path.join(test_file_path, "test_demo_full_example.json"), "--json",
+                                      "--quiet")
+        self.assertEqual(0, output.returncode)
+        self.assertEqual("b''", str(output.stdout))
+
         # test logfile
         output = _run_compliance_tool("e", os.path.join(test_file_path, "test_demo_full_example.json"), "--json", "-l")
         self.assertNotEqual(0, output.returncode)

sdk/basyx/aas/adapter/_generic.py

@@ -37,7 +37,8 @@
 ASSET_KIND: Dict[model.AssetKind, str] = {
     model.AssetKind.TYPE: 'Type',
     model.AssetKind.INSTANCE: 'Instance',
-    model.AssetKind.NOT_APPLICABLE: 'NotApplicable'}
+    model.AssetKind.NOT_APPLICABLE: 'NotApplicable',
+    model.AssetKind.ROLE: 'Role'}
 
 QUALIFIER_KIND: Dict[model.QualifierKind, str] = {
     model.QualifierKind.CONCEPT_QUALIFIER: 'ConceptQualifier',

sdk/basyx/aas/adapter/json/json_deserialization.py

@@ -511,8 +511,6 @@ def _construct_data_specification_iec61360(cls, dct: Dict[str, object],
             ret.value_list = cls._construct_value_list(_get_ts(dct, 'valueList', dict))
         if 'value' in dct:
             ret.value = _get_ts(dct, 'value', str)
-        if 'valueId' in dct:
-            ret.value_id = cls._construct_reference(_get_ts(dct, 'valueId', dict))
         if 'levelType' in dct:
             for k, v in _get_ts(dct, 'levelType', dict).items():
                 if v:
@@ -528,9 +526,12 @@ def _construct_entity(cls, dct: Dict[str, object], object_class=model.Entity) ->
         if 'specificAssetIds' in dct:
             for desc_data in _get_ts(dct, "specificAssetIds", list):
                 specific_asset_id.add(cls._construct_specific_asset_id(desc_data, model.SpecificAssetId))
-
+        if 'entityType' in dct:
+            entity_type = ENTITY_TYPES_INVERSE[_get_ts(dct, 'entityType', str)]
+        else:
+            entity_type = None
         ret = object_class(id_short=None,
-                           entity_type=ENTITY_TYPES_INVERSE[_get_ts(dct, "entityType", str)],
+                           entity_type=entity_type,
                            global_asset_id=global_asset_id,
                            specific_asset_id=specific_asset_id)
         cls._amend_abstract_attributes(ret, dct)

sdk/basyx/aas/adapter/json/json_serialization.py

@@ -476,7 +476,8 @@ def _blob_to_json(cls, obj: model.Blob) -> Dict[str, object]:
         :return: dict with the serialized attributes of this object
         """
         data = cls._abstract_classes_to_json(obj)
-        data['contentType'] = obj.content_type
+        if obj.content_type is not None:
+            data['contentType'] = obj.content_type
         if obj.value is not None:
             data['value'] = base64.b64encode(obj.value).decode()
         return data
@@ -490,7 +491,8 @@ def _file_to_json(cls, obj: model.File) -> Dict[str, object]:
         :return: dict with the serialized attributes of this object
         """
         data = cls._abstract_classes_to_json(obj)
-        data['contentType'] = obj.content_type
+        if obj.content_type is not None:
+            data['contentType'] = obj.content_type
         if obj.value is not None:
             data['value'] = obj.value
         return data
@@ -576,8 +578,7 @@ def _annotated_relationship_element_to_json(cls, obj: model.AnnotatedRelationshi
         :param obj: object of class AnnotatedRelationshipElement
         :return: dict with the serialized attributes of this object
         """
-        data = cls._abstract_classes_to_json(obj)
-        data.update({'first': obj.first, 'second': obj.second})
+        data = cls._relationship_element_to_json(obj)
         if not cls.stripped and obj.annotation:
             data['annotations'] = list(obj.annotation)
         return data
@@ -635,10 +636,11 @@ def _entity_to_json(cls, obj: model.Entity) -> Dict[str, object]:
         data = cls._abstract_classes_to_json(obj)
         if not cls.stripped and obj.statement:
             data['statements'] = list(obj.statement)
-        data['entityType'] = _generic.ENTITY_TYPES[obj.entity_type]
-        if obj.global_asset_id:
+        if obj.entity_type is not None:
+            data['entityType'] = _generic.ENTITY_TYPES[obj.entity_type]
+        if obj.global_asset_id is not None:
             data['globalAssetId'] = obj.global_asset_id
-        if obj.specific_asset_id:
+        if obj.specific_asset_id is not None:
             data['specificAssetIds'] = list(obj.specific_asset_id)
         return data
 

sdk/basyx/aas/adapter/xml/xml_deserialization.py

@@ -827,10 +827,14 @@ def construct_entity(cls, element: etree._Element, object_class=model.Entity, **
             for id in _child_construct_multiple(specific_asset_ids, NS_AAS + "specificAssetId",
                                                 cls.construct_specific_asset_id, cls.failsafe):
                 specific_asset_id.add(id)
-
+        entity_type_text = _get_text_or_none(element.find(NS_AAS + "entityType"))
+        if entity_type_text is not None:
+            entity_type = ENTITY_TYPES_INVERSE[entity_type_text]
+        else:
+            entity_type = None
         entity = object_class(
             id_short=None,
-            entity_type=_child_text_mandatory_mapped(element, NS_AAS + "entityType", ENTITY_TYPES_INVERSE),
+            entity_type=entity_type,
             global_asset_id=_get_text_or_none(element.find(NS_AAS + "globalAssetId")),
             specific_asset_id=specific_asset_id)
 

sdk/basyx/aas/adapter/xml/xml_serialization.py

@@ -628,7 +628,8 @@ def blob_to_xml(obj: model.Blob,
     if obj.value is not None:
         et_value.text = base64.b64encode(obj.value).decode()
     et_blob.append(et_value)
-    et_blob.append(_generate_element(NS_AAS + "contentType", text=obj.content_type))
+    if obj.content_type is not None:
+        et_blob.append(_generate_element(NS_AAS + "contentType", text=obj.content_type))
     return et_blob
 
 
@@ -644,7 +645,8 @@ def file_to_xml(obj: model.File,
     et_file = abstract_classes_to_xml(tag, obj)
     if obj.value:
         et_file.append(_generate_element(NS_AAS + "value", text=obj.value))
-    et_file.append(_generate_element(NS_AAS + "contentType", text=obj.content_type))
+    if obj.content_type is not None:
+        et_file.append(_generate_element(NS_AAS + "contentType", text=obj.content_type))
     return et_file
 
 
@@ -734,8 +736,10 @@ def relationship_element_to_xml(obj: model.RelationshipElement,
     :return: Serialized :class:`~lxml.etree._Element` object
     """
     et_relationship_element = abstract_classes_to_xml(tag, obj)
-    et_relationship_element.append(reference_to_xml(obj.first, NS_AAS+"first"))
-    et_relationship_element.append(reference_to_xml(obj.second, NS_AAS+"second"))
+    if obj.first is not None:
+        et_relationship_element.append(reference_to_xml(obj.first, NS_AAS+"first"))
+    if obj.second is not None:
+        et_relationship_element.append(reference_to_xml(obj.second, NS_AAS+"second"))
     return et_relationship_element
 
 
@@ -823,7 +827,8 @@ def entity_to_xml(obj: model.Entity,
         for statement in obj.statement:
             et_statements.append(submodel_element_to_xml(statement))
         et_entity.append(et_statements)
-    et_entity.append(_generate_element(NS_AAS + "entityType", text=_generic.ENTITY_TYPES[obj.entity_type]))
+    if obj.entity_type:
+        et_entity.append(_generate_element(NS_AAS + "entityType", text=_generic.ENTITY_TYPES[obj.entity_type]))
     if obj.global_asset_id:
         et_entity.append(_generate_element(NS_AAS + "globalAssetId", text=obj.global_asset_id))
     if obj.specific_asset_id:

sdk/basyx/aas/examples/data/example_aas.py

@@ -23,7 +23,7 @@
 _embedded_data_specification_iec61360 = model.EmbeddedDataSpecification(
     data_specification=model.ExternalReference((model.Key(type_=model.KeyTypes.GLOBAL_REFERENCE,
                                                           value='https://admin-shell.io/DataSpecificationTemplates/'
-                                                                'DataSpecificationIEC61360/3'),)),
+                                                                'DataSpecificationIEC61360/3/1'),)),
     data_specification_content=model.DataSpecificationIEC61360(preferred_name=model.PreferredNameTypeIEC61360({
         'de': 'Test Specification',
         'en-US': 'TestSpecification'