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.

Sign up for GitHub

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

Extend example file READMEs and fix broken links #491

Merged
merged 1 commit into from
Dec 4, 2024
Merged

Extend example file READMEs and fix broken links #491

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion schemas/json/examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# JSON Examples

These are randomly generated examples that fulfill 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
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# RDF Examples

These are randomly generated examples that fulfill 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
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# XML Examples

These are randomly generated examples that fulfill 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