From 5e0351b0d39a556534ef44f37a5fca4d953c9d96 Mon Sep 17 00:00:00 2001 From: s-heppner Date: Fri, 29 Nov 2024 13:43:24 +0100 Subject: [PATCH] Extend example file READMEs and fix broken links 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. --- schemas/json/examples/README.md | 12 +++++++++++- schemas/rdf/examples/README.md | 12 +++++++++++- schemas/xml/examples/README.md | 13 +++++++++++-- 3 files changed, 33 insertions(+), 4 deletions(-) diff --git a/schemas/json/examples/README.md b/schemas/json/examples/README.md index cd6df1001..aeb27fc06 100644 --- a/schemas/json/examples/README.md +++ b/schemas/json/examples/README.md @@ -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: @@ -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 diff --git a/schemas/rdf/examples/README.md b/schemas/rdf/examples/README.md index cc1642f0c..664de3ef5 100644 --- a/schemas/rdf/examples/README.md +++ b/schemas/rdf/examples/README.md @@ -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: @@ -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 diff --git a/schemas/xml/examples/README.md b/schemas/xml/examples/README.md index e6ab7a99d..61f9bae48 100644 --- a/schemas/xml/examples/README.md +++ b/schemas/xml/examples/README.md @@ -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: @@ -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