Skip to content

Commit

Permalink
Extend example file READMEs and fix broken links
Browse files Browse the repository at this point in the history
This extends the description for the
`README.md` inside the example folders
of the XML, JSON and RDF schemas.

Furthrmore, it fixes some broken links
in the `README.md`s.
  • Loading branch information
s-heppner committed Nov 29, 2024
1 parent ea938a5 commit 2b46639
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 4 deletions.
12 changes: 11 additions & 1 deletion schemas/json/examples/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# JSON Examples

These are randomly generated examples that fulfil the formalized semantic and syntactic constraints,
however due to the random generation, they might not make sense.
They're best suited for testing your software.

The examples were automatically generated by [aas-core3.0-testgen].

There are two kinds of examples for each class of the meta-model:
Expand All @@ -10,5 +14,11 @@ There are two kinds of examples for each class of the meta-model:
Apart from the two examples, we also generate various additional examples for different properties based on fuzzing.
For example, see [generated/AnnotatedRelationshipElement/idShortOverPatternExamples/fuzzed\_01.json].

For more details on the logic behind the generation, please refer to the following two publications:
- [Semi-Automatic Testing of Data-Focused Software Development Kits for Industrie 4.0]
- [Maturity Evaluation of SDKs for I4.0 Digital Twins]

[aas-core3.0-testgen]: https://github.com/aas-core-works/aas-core3.0-testgen
[generated/AnnotatedRelationshipElement/idShortOverPatternExamples/fuzzed\_01.json]: generated/AnnotatedRelationshipElement/idShortOverPatternExamples/fuzzed\_01.json
[generated/AnnotatedRelationshipElement/idShortOverPatternExamples/fuzzed\_01.json]: generated/AnnotatedRelationshipElement/idShortOverPatternExamples/fuzzed_01.json
[Semi-Automatic Testing of Data-Focused Software Development Kits for Industrie 4.0]: https://www.researchgate.net/publication/366347536_Semi-Automatic_Testing_of_Data-Focused_Software_Development_Kits_for_Industrie_40
[Maturity Evaluation of SDKs for I4.0 Digital Twins]: https://www.researchgate.net/publication/374055610_Maturity_Evaluation_of_SDKs_for_I40_Digital_Twins
12 changes: 11 additions & 1 deletion schemas/rdf/examples/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# RDF Examples

These are randomly generated examples that fulfil the formalized semantic and syntactic constraints,
however due to the random generation, they might not make sense.
They're best suited for testing your software.

The examples were automatically generated by [aas-core3.0-testgen].

There are two kinds of examples for each class of the meta-model:
Expand All @@ -10,5 +14,11 @@ There are two kinds of examples for each class of the meta-model:
Apart from the two examples, we also generate various additional examples for different properties based on fuzzing.
For example, see [generated/AnnotatedRelationshipElement/idShortOverPatternExamples/fuzzed\_01.ttl].

For more details on the logic behind the generation, please refer to the following two publications:
- [Semi-Automatic Testing of Data-Focused Software Development Kits for Industrie 4.0]
- [Maturity Evaluation of SDKs for I4.0 Digital Twins]

[aas-core3.0-testgen]: https://github.com/aas-core-works/aas-core3.0-testgen
[generated/AnnotatedRelationshipElement/idShortOverPatternExamples/fuzzed\_01.ttl]: generated/AnnotatedRelationshipElement/idShortOverPatternExamples/fuzzed\_01.ttl
[generated/AnnotatedRelationshipElement/idShortOverPatternExamples/fuzzed\_01.ttl]: generated/AnnotatedRelationshipElement/idShortOverPatternExamples/fuzzed_01.ttl
[Semi-Automatic Testing of Data-Focused Software Development Kits for Industrie 4.0]: https://www.researchgate.net/publication/366347536_Semi-Automatic_Testing_of_Data-Focused_Software_Development_Kits_for_Industrie_40
[Maturity Evaluation of SDKs for I4.0 Digital Twins]: https://www.researchgate.net/publication/374055610_Maturity_Evaluation_of_SDKs_for_I40_Digital_Twins
13 changes: 11 additions & 2 deletions schemas/xml/examples/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# XML Examples

These are randomly generated examples that fulfil the formalized semantic and syntactic constraints,
however due to the random generation, they might not make sense.
They're best suited for testing your software.

The examples were automatically generated by [aas-core3.0-testgen].

There are two kinds of examples for each class of the meta-model:
Expand All @@ -10,6 +14,11 @@ There are two kinds of examples for each class of the meta-model:
Apart from the two examples, we also generate various additional examples for different properties based on fuzzing.
For example, see [generated/annotatedRelationshipElement/idShortOverPatternExamples/fuzzed\_01.xml].

[aas-core3.0-testgen]: https://github.com/aas-core-works/aas-core3.0-testgen
[generated/annotatedRelationshipElement/idShortOverPatternExamples/fuzzed\_01.xml]: generated/AnnotatedRelationshipElement/idShortOverPatternExamples/fuzzed\_01.xml
For more details on the logic behind the generation, please refer to the following two publications:
- [Semi-Automatic Testing of Data-Focused Software Development Kits for Industrie 4.0]
- [Maturity Evaluation of SDKs for I4.0 Digital Twins]

[aas-core3.0-testgen]: https://github.com/aas-core-works/aas-core3.0-testgen
[generated/annotatedRelationshipElement/idShortOverPatternExamples/fuzzed\_01.xml]: generated/annotatedRelationshipElement/idShortOverPatternExamples/fuzzed_01.xml
[Semi-Automatic Testing of Data-Focused Software Development Kits for Industrie 4.0]: https://www.researchgate.net/publication/366347536_Semi-Automatic_Testing_of_Data-Focused_Software_Development_Kits_for_Industrie_40
[Maturity Evaluation of SDKs for I4.0 Digital Twins]: https://www.researchgate.net/publication/374055610_Maturity_Evaluation_of_SDKs_for_I40_Digital_Twins

0 comments on commit 2b46639

Please sign in to comment.