Skip to content

Commit

Permalink
Document pattern deviation from specification
Browse files Browse the repository at this point in the history
We document in the JSON and RDF schema `README`
files, that we deviate from the pattern in the
specification of AASd-130, due to the fact that
most schema engines test UTF-16, instead
of the used UTF-32.

For the full discussion, refer to #362
  • Loading branch information
s-heppner committed Nov 15, 2024
1 parent b11bbab commit 0937286
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
5 changes: 5 additions & 0 deletions schemas/json/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,11 @@ the [mapping of XSD to JSON types] into account.

[5.7.12 Primitive and Simple Data Types]: https://industrialdigitaltwin.org/wp-content/uploads/2023/04/IDTA-01001-3-0_SpecificationAssetAdministrationShell_Part1_Metamodel.pdf#page=96

#### Note: Pattern Deviation from the Specification
Since most JSON schema engines we tested operated on UTF-16 and could not handle UTF-32, we transpiled the pattern from AASd-130, which uses UTF-32 in the specification, into UTF-16.
This is a trade-off between correctness and practicality.
See [#362](https://github.com/admin-shell-io/aas-specs/issues/362) for the details.

#### Hint: Round-Trip Conversions

Round-trip conversions XML to JSON to XML or RDF to JSON to RDF may not result in the
Expand Down
5 changes: 5 additions & 0 deletions schemas/rdf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,11 @@ following:
validation errors in the shapes. RDF does not contain a concept for abstract classes,
therefore custom checks using SPARQL queries are supplied.

#### Note: Pattern Deviation from the Specification
Since most RDFS engines we tested operated on UTF-16 and could not handle UTF-32, we transpiled the pattern from AASd-130, which uses UTF-32 in the specification, into UTF-16.
This is a trade-off between correctness and practicality.
See [#362](https://github.com/admin-shell-io/aas-specs/issues/362) for the details.

## Example Overview

RDF is often regarded as a graph model, as it provides the flexibility to interlink
Expand Down

0 comments on commit 0937286

Please sign in to comment.