Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the schemata to v3.1 of the specification #357

Merged
merged 13 commits into from
Dec 12, 2024

Conversation

s-heppner
Copy link
Collaborator

@s-heppner s-heppner commented Feb 21, 2024

This PR updates the schema files to v3.1 of the
specification. The changes with respect to v3.0.1
can be found here in the specification.

BirgitBoss and others added 6 commits November 23, 2023 16:02
* sync with head repository (#8)

* move issue templates from workflows folder to ISSUE_TEMPLATE folder

* update readme

* Synronize with admin-shell-io (#9)

* move issue templates from workflows folder to ISSUE_TEMPLATE folder

* update readme
Minor editorial changes + V3.0 published by IDTA
* Update CONTRIBUTING.md

- add chapter about issue handling
- make text generic so that it fits 
   to all specification repos
- for specifics for IDA-01001 etc. 
   special comments/sections are introduced
- specifications now handled by IDTA

* Update CONTRIBUTING.md

- new section on naming of github repositories 
   starting with "aas-specs"

* Update CONTRIBUTING.md

- add section on license headers & Licensing

* Update CONTRIBUTING.md

fix typo

* Incorporate findings from review
These schemata are not tested yet and are meant
for reference only.
They are not the offical final version.
@s-heppner s-heppner marked this pull request as draft February 21, 2024 13:21
@s-heppner s-heppner changed the title Update the schemata to v3.1 of the specification. Update the schemata to v3.1 of the specification Feb 21, 2024
Previously, PathType was matched towards
RFC 8089, however this posed several problems.

In #299, the decision was to change the PathType
to xs:anyURI.
This reflects this change.
@mristin
Copy link
Collaborator

mristin commented Feb 27, 2024

I'll try to have a look at this tonight.

@mristin
Copy link
Collaborator

mristin commented Feb 28, 2024

@s-heppner I think I reproduced the issue in a small schema:

<?xml version="1.0" encoding="UTF-8" ?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="something">
    <xs:simpleType>
          <xs:restriction base="xs:string">
               <xs:pattern value="[ -\ud7ff\uf900-\ufdcf\ufdf0-\uffef\U00010000-\U0001fffd])"/>
          </xs:restriction>
    </xs:simpleType>
</xs:element>
</xs:schema>

This schema does not validate with https://www.liquid-technologies.com/online-xsd-validator.

I'm looking into how to represent character code points above Basic Multilingual Plane (https://en.wikipedia.org/wiki/Plane_(Unicode)).

@mristin
Copy link
Collaborator

mristin commented Feb 28, 2024

After some search, it seems that this is highly dependent on the XSD validator used. We currently use a validator based on C# in the continuous integration, so the patterns are directly forwarded to the C# regex engine.

As C# supports only UTF-16, the code points above BMP can not be represented. The solution would be to expand the pattern so that only UTF-16 ranges are used. This is closely related to #362. Whatever the solution in #362, the same patch needs to be applied here as well.

We haven't noticed this problem thus far as no code points above BMP have appeared in XSD.

Just for future reference: a possible solution is to patch aas-core-codegen to fix patterns in XSD so that they only operate on UTF-16 characters and ranges.

@BirgitBoss BirgitBoss added the Schemas generated schemata for xml, JSON and rdf or XMI label May 5, 2024
s-heppner and others added 5 commits June 20, 2024 20:39
* WIP: Adapt the schema files to v3.0.1

This adapts the schema files to version 3.0.1
of the specification.
However, this is not an official release yet
and may be subject to change.

* Schema Remove Pattern for PathType

Currently, the regex for Path type is
non-compliant to the specification v3.0,
as it does not allow for AASX packages
to be written.

As a temporary bugfix in v3.0.1, it was decided
to remove the invariant check, as changing the
pattern would result in a breaking change.
This is of course no final solution,
there will be a better fix for version 3.1.

See #299

* Update schema files to newest version of aas-core

* Update JSON Examples to v3.0.1

* Update RDF Examples to v3.0.1

* Update XML examples to v3.0.1

* Specify metamodel version in JSON Schema

Previously, the metamodel version was not clear
from the generated JSON schema.
We adapt the title to include the version.
* xmi Export for V3.0.1 Bugfix Release as norma and Enterprise Architect Specific xmi format

* Readme update
- new bugfix version 3.0.8
@s-heppner s-heppner requested a review from BirgitBoss November 8, 2024 08:36
Copy link
Collaborator

@BirgitBoss BirgitBoss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no merge to main but only to branch IDTA-01001-3-1

@s-heppner s-heppner changed the base branch from master to IDTA-01001-3-1_working November 15, 2024 10:04
@s-heppner
Copy link
Collaborator Author

I've changed the target branch. Is this correct now?

@s-heppner s-heppner marked this pull request as ready for review December 12, 2024 07:54
@s-heppner s-heppner merged commit df0107e into IDTA-01001-3-1_working Dec 12, 2024
1 of 2 checks passed
@s-heppner s-heppner deleted the SeHe/IDTA-01001-3-1_schemata branch December 12, 2024 08:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Schemas generated schemata for xml, JSON and rdf or XMI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants