Update Schemas to V3.0RC02 (#207)

Major changes include:
* Update of all schema files to the AAS metamodel version 3.0RC02
* Replacement of most (manually created) examples by new (automatically generated) ones
* Extensive extensions to the explanations in the Readme files
* Introducing YAML files for the AAS Part 2 API definitions

Author: sebbader

.github/workflows/AdditionalVerbsInImperativeMood.txt

@@ -0,0 +1,25 @@
+unit test
+integration test
+rewrap
+unwrap
+re-wrap
+undo
+re-do
+inline
+in-line
+assign
+standardize
+verbosify
+log
+integrate
+enhance
+untrack
+refine
+dispatch
+export
+skip
+redirect
+deduplicate
+re-order
+position
+restrict

.github/workflows/check-title-and-description-of-pull-request.yml

@@ -11,7 +11,9 @@ jobs:
       - uses: actions/checkout@master
 
       - name: Check the title and description of the pull request
-        uses: mristin/[email protected]
+        uses: mristin/[email protected]
+        with:
+          path-to-additional-verbs: .github/workflows/AdditionalVerbsInImperativeMood.txt
 
       - name: READ HERE ON FAILURE FOR MORE INSTRUCTIONS
         if: ${{ failure() }}

.gitignore

@@ -1 +1,2 @@
 .idea/
+deleteme*.py

CONTRIBUTING.md

@@ -37,10 +37,14 @@ The commit messages follow the guidelines from https://chris.beams.io/posts/git-
 * Use the body to explain *what* and *why* (instead of *how*)
 
 ## Create Pull Request
-After all changes have been committed to your feature branch, a [pull request] has to be created. See [this Github tutorial] for more guidance. 
+After all changes have been committed to your feature branch, a [pull request] (PR) has to be created.
+Every PR should be linked to an issue for tracking.
+See [this Github tutorial] for more guidance. 
 
 [pull request]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
 
+[link PR to issue]: https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue
+
 ## Pre-Merge Checks
 **Continuous Integration.**
 Github will run the continuous integration (CI) automatically through Github actions to verify that the submitted changes are valid.
@@ -83,13 +87,16 @@ Major changes must first be reviewed and approved by the joint working group "As
 [Platform Industrie 4.0]: http://www.plattform-i40.de
 [IDTA]: https://industrialdigitaltwin.org/
 
+
+## Merge into Master Branch
+
 After the approval the pull request can be merged into the repository. This is done by one of the maintainers.
 
 
 ## Post-Merge Cleanup
 **Congratulation.**
 You successfully contributed to the aas-spec repository.
 
-If you are a member of the development team, pleas delete the feature branch you directly created within the aas-specs repository.
+If you are a member of the development team, please delete the feature branch you directly created within the aas-specs repository.
 
-Otherwise, if you are not part of the team and you forked the repository, feel free to delete your fork.
+Otherwise, if you are not part of the team and you forked the repository, feel free to delete your fork.

README.md

@@ -1,4 +1,4 @@
-# aas-specs (V3.x)
+# This is the repository of the Asset Administration Shell
 
 [![Check](
 https://github.com/admin-shell-io/aas-specs/workflows/Check/badge.svg
@@ -11,15 +11,15 @@ https://licensebuttons.net/l/by/4.0/88x31.png
 https://creativecommons.org/licenses/by/4.0/
 )
 
-This repository provides the specifications of Asset Administration Shell.
+This repository contains specifications of the Asset Administration Shell, including the normative schemas of the serializations, the rules applied to create them, how the specification is mapped into the serializations, and examples of how to use the schemas.
 
 ## Schemas
 
-We provide schemas of the Asset Administration Shell for JSON, RDF and XML. 
+The schemas of the Asset Administration Shell for JSON, RDF and XML as well as a XMI and YAML representation of the metmodel are provided in the respective directories. 
 These schemas are derived from the document series, part 1,
 ["Details of the Asset Administration Shell"](
 https://www.plattform-i40.de/PI40/Redaktion/EN/Standardartikel/specification-administrationshell.html
-) published by [Platform Industrie 4.0](http://www.plattform-i40.de).
+) published by the [Platform Industrie 4.0](http://www.plattform-i40.de) and [IDTA](https://industrialdigitaltwin.org/en/).
 
 ### JSON
 
@@ -36,13 +36,26 @@ The XML schema, mapping rules and examples are available at [schemas/xml/](schem
 
 ### XMI
 
-The XMI file for the UML metamodel [schemas/xmi/](schemas/xmi/).
+The XMI file for the UML metamodel is available at [schemas/xmi/](schemas/xmi/).
 
+### YAML
+
+The YAML files for the API definitions are available at [schemas/yaml/](schemas/yaml/).
+
+  
 ## Releases
 
-Currently, the following releases are available (see also the [releases](https://github.com/admin-shell-io/aas-specs/releases) section of this repository):
-* [3.0.2.RC01](https://github.com/admin-shell-io/aas-specs/releases/tag/v3.0.2.RC01) is a pre-release that solves several typos and bugs of `3.0.1.RC01`
-* [3.0.1.RC01](https://github.com/admin-shell-io/aas-specs/releases/tag/v3.0.1.RC01) is a pre-release that solves a bug in the JSON schema of `3.0.RC01`
+The following versioning scheme is applied: 'V\<major>.\<minor>.\<patch>'. 
+Major versions indicate breaking changes while minor updates are backward compatible.
+The patch position is increased whenever bugfixes need to be applied. Note that, as long as the UML-based metamodel has the state of a "Release Candidate", the acronym 'RC' followed by the number of the corresponding release candidate is added to the patch position.
+The following release contains the latest version of the AAS schemas (see also the [releases](https://github.com/admin-shell-io/aas-specs/releases) section of this repository):
+* [3.0.5RC02](https://github.com/admin-shell-io/aas-specs/releases/tag/V3.0.5RC02) is the corresponding release for the `V3.0RC02` version of the AAS metamodel, containing the normative schemas for the published document "Part 1: Details of the Asset Administration Shell - The exchange of information between partners in the value chain of Industrie 4.0 - **Version 3.0RC02**". *Use this release if you want to work with the latest specified AAS version.*
+
+Previous releases (deprecated by [3.0.5RC02](https://github.com/admin-shell-io/aas-specs/releases/tag/V3.0.5RC02)):
+* [3.0.4RC01](https://github.com/admin-shell-io/aas-specs/releases/tag/V3.0.4RC01) is the final release for the `V3.0RC01` version of the AAS metamodel, containing the normative schemas for the published document "Part 1: Details of the Asset Administration Shell - The exchange of information between partners in the value chain of Industrie 4.0 - Version 3.0RC01". *No additional bugfix or patch releases for the metamodel version `V3.0RC01` shall be expected.*
+* [3.0.3RC01](https://github.com/admin-shell-io/aas-specs/tree/V3.0.3RC01) is a pre-release of the schemas for the published document "Part 1: Details of the Asset Administration Shell - The exchange of information between partners in the value chain of Industrie 4.0 - Version 3.0RC01" that solves several typos and bugs of `3.0.2.RC01`
+* [3.0.2.RC01](https://github.com/admin-shell-io/aas-specs/releases/tag/v3.0.2.RC01) is a pre-release of the schemas for the published document "Part 1: Details of the Asset Administration Shell - The exchange of information between partners in the value chain of Industrie 4.0 - Version 3.0RC01" that solves several typos and bugs of `3.0.1.RC01`
+* [3.0.1.RC01](https://github.com/admin-shell-io/aas-specs/releases/tag/v3.0.1.RC01) is a pre-release of the schemas for the published document "Part 1: Details of the Asset Administration Shell - The exchange of information between partners in the value chain of Industrie 4.0 - Version 3.0RC01" that solves a bug in the JSON schema of `3.0.RC01`
 * [3.0.RC01](https://github.com/admin-shell-io/aas-specs/releases/tag/v3.0.RC01) is a pre-release containing the schemes as contained by the document 'Details of the Asset Administration Shell - Part 1 - Version 3.0.RC01' [download](https://www.plattform-i40.de/PI40/Redaktion/EN/Downloads/Publikation/Details_of_the_Asset_Administration_Shell_Part1_V3.html)
 
 
@@ -58,6 +71,5 @@ If you want to contribute, see [CONTRIBUTING.md](CONTRIBUTING.md).
 ## License
 
 This work is licensed under a [Creative Commons Attribution 4.0 International License](
-https://creativecommons.org/licenses/by/4.0/). The implementation uses the concepts of the
-document "Details of the Asset Administration Shell" published on www.plattform-i40.de
-which is licensed under Creative Commons CC BY 4.0.
+https://creativecommons.org/licenses/by/4.0/). The implementation is based on the specifications of the "Details of the Asset Administration Shell" published on https://www.plattform-i40.de and https://industrialdigitaltwin.org/en/ 
+which is licensed under Creative Commons CC-BY-4.0.

schemas/Validate.ps1

@@ -24,6 +24,12 @@ function Main
         throw "JSON validation failed."
     }
 
+    Write-Host "Validating XML ..."
+    & $(Join-Path $schemaValidationDir "ValidateXml") --inputs 'xml\examples\*.xml' --schema 'xml\AAS.xsd'
+    if($LASTEXITCODE -ne 0) 
+    {
+        throw "XML validation failed."
+    }
 
     Write-Host "Validating RDF ..."
     & $(Join-Path $schemaValidationDir "ValidateRdf") --model 'rdf\rdf-ontology.ttl'
@@ -38,14 +44,6 @@ function Main
         throw "RDF validation failed."
     }
 
-
-    Write-Host "Validating XML ..."
-    & $(Join-Path $schemaValidationDir "ValidateXml") --inputs 'xml\examples\*.xml' --schema 'xml\AAS.xsd'
-    if($LASTEXITCODE -ne 0) 
-    {
-        throw "XML validation failed."
-    }
-
     Pop-Location
 }
 Main