Update/metamodel v3.1.2#484
Merged
s-heppner merged 28 commits intoMay 7, 2026
Merged
Conversation
Prepare Release v2.0.0 # Release Notes Version 2.0.0 of the BaSyx-Python SDK comes with a major refactoring of the server and a renewed concept for data persistence. Previously, the server code was split between the `sdk` and `server` packages (due to historic development of the code). Now all the code relevant just for the server is located in `server`, where it belongs. Since this means, some code that was previously in `sdk` is not there anymore, this is a breaking change and warranted the new major release. > [!note] > This release does not have any changes in implemented AAS specification versions. It is the preparotory release in order to get ready for the new versions of the specifications, as well as new features for the SDK, such as Registry and Discovery server. > [!warning] > Due to these major refactorings, there were some backward incompatible changes. Please check the documentation, if you encounter any issues. # Changelog **Notable:** - Backward Incompatible: Refactor server functionality from `sdk` to `server` (See: eclipse-basyx#388) - Backward Incompatible: Refactor `backend` concept for data persistence (See: eclipse-basyx#370) - Backward Incompatible: Refactor server `start-up` options (See: eclipse-basyx#418) - Remove support for Python 3.9 (as it is EoL) (See eclipse-basyx#433) **Improvements:** - Clarify documentation of running the server with Docker (See: eclipse-basyx#398) - Document running the server without Docker (See: eclipse-basyx#403) - Improve XML serialization (See: eclipse-basyx#406) - Improve server reading of JSON and XML files (See: eclipse-basyx#408) - Add more utility methods for `Referable` and `Key` handling (See: eclipse-basyx#410) **Bugfixes:** - Fix type issues found with a new version of `mypy` (See: eclipse-basyx#399) - Fix parsing of `ConceptDescription`s in the server (See: eclipse-basyx#420) - Update `pyecma376-2` and `lxml` dependencies (See: eclipse-basyx#419)
* update constraint AASd-002 * adapt regex * fix docs
Previously, Python 3.9 reached its EOL. This replace all references to Python 3.9 within the SDK with references to Python 3.10. Fixes eclipse-basyx#432
Syncing with develop (copyright mismatch).
AASd-090 is removed, since category is deprecated ([Changelog/AASd-090](https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1.2/changelog.html#:~:text=REMOVED:%20remove%20AASd%2D090:%20category%20is%20deprecated%20(#514))). This means, we do not check that `DataElement.category` is one of `["CONSTANT", "PARAMETER", "VARIABLE"]` anymore. Co-authored-by: Leon Huang <hleon@157-023.eduroam.rwth-aachen.de>
With version 3.1.2, the `base.AssetKind` enumeration now has an additional `Role` value. See the [Spec-Changelog](https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1.2/changelog.html#:~:text=AssetKind/Role,-New%20value%20in)). --------- Co-authored-by: Leon Huang <hleon@088-095.eduroam.rwth-aachen.de>
This updates the constraint documentation for version 3.1.2. Replace "needs to" with "shall" ([AASd-006](https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1.2/changelog.html#:~:text=AASd%2D006,-Update), [AASd-007](https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1.2/changelog.html#:~:text=AASd%2D007,-Update), [AASd-021](https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1.2/changelog.html#:~:text=AASd%2D021,-Update), [AASd-077](https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1.2/changelog.html#:~:text=AASd%2D077,-Update)) in Docstrings. Update documentation for [AASd-116](https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1.2/changelog.html#:~:text=AASd%2D116,-Update). --------- Co-authored-by: Leon Huang <hleon@151-020.eduroam.rwth-aachen.de> Co-authored-by: Leon Huang <hleon@157-023.eduroam.rwth-aachen.de> Co-authored-by: Leon Huang <hleon@174-165.eduroam.rwth-aachen.de>
AASd-014: `entityType` now optional. Update documentation and changed related code accordingly ([Changelog/AASd-014](https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1.2/changelog.html#:~:text=CHANGED:%20Entity/entityType%20and%20Constraint%20AASd%2D014:%20entityType%20now%20optional%20(#287))).
Previously, we had some weird bugs with the CI pipeline sometimes failing (eclipse-basyx#400), but not always reproducible. Namely, sometimes the CI failed, due to `mypy` not finding the `sdk` types when running from the `compliance_tool` environment. Since currently, we are at a point where it is impossible to reproduce the failing CI (at least for me), I decided to clean up the job definitions a little bit and make some things more explicit. Namely, instead of calling scripts like `pip` or `mypy` from their PATH, we now explicitly call them via `python -m pip` and `python -m mypy`. This theoretically ensures, that it always uses the script we just installed with the dependencies and not something the VM already had in its path via `actions/setup-python@v5`. This should ensure that a script like `mypy` actually has all the necessary dependencies installed. Secondly, we had a `pip install -e ../sdk[dev]`, therefore installing the development dependencies of the `sdk` in the `compliance_tool` CI check. This is technically incorrect, since we use the `sdk` as external dependency and therefore shouldn't depend on the development dependencies. I therefore removed this. Lastly, the `sdk-readme-codeblocks` check uses `bash` syntax. In theory, the Ubuntu environment should use `bash` by default, but now it is made explicit. Fixes eclipse-basyx#400 (hopefully)
Update to version 3.1 of the metamodel made the `content_type` attribute of classes `Blob` and `File` optional. See the link to [the spec] for details. [the spec]: https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1.2/changelog.html#_metamodel_changes_v3_1_vs_v3_0_2
Update to version 3.1 of the spec removed constraint AASd-120. See [the spec] for more details. [the spec]: https://industrialdigitaltwin.io/aas-specifications/IDTA-01001/v3.1.2/changelog.html#:~:text=AASd%2D120,-Removed Co-authored-by: Leon Huang <hleon@088-095.eduroam.rwth-aachen.de>
…clipse-basyx#375) This adds a `server-publish` configuration that publishes the server Docker image on DockerHub. The logic is in line with the basyx-java-server. --------- Co-authored-by: s-heppner <iat@s-heppner.com>
…se-basyx#481) Remove multiplatform support from DockerHub publishing for now --------- Co-authored-by: Sercan Sahin <s.sahin@iat.rwth-aachen.de>
Until we implement eclipse-basyx#485 and update the `compliance-tool` properly, we should exclude it from the CI tests.
zrgt
requested changes
May 6, 2026
Contributor
zrgt
left a comment
zrgt
left a comment
There was a problem hiding this comment.
It would be useful to add tests for new optional fields:
- AssetKind.ROLE round-trip (JSON + XML)
- Blob/File with content_type=None round-trip
- RelationshipElement with first=None/second=None
- Entity with entity_type=None
Co-authored-by: Igor Garmaev <56840636+zrgt@users.noreply.github.com>
Previously, elements of a `SubmodelElementList` would have their `id_short` overwritten by our reference hack. This now only sets an temporary `id_short`, if the `id_short` does not exist. Furthermore, it only removes the `id_short` when removing the element from the `SubmodelElementList`, if it is one of the generated ones.
s-heppner
force-pushed
the
update/Metamodel_V3.1.2
branch
from
a64d199 to
f203bed
Compare
Member
Author
|
You're welcome to open issues planning out additional test cases. For now we should get this merged into |
zrgt
approved these changes
May 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This implements the changes of the metamodel for version 3.1.2 of the spec.
Fixes #437