Added example AAS and included it in the documentation (#909)

* Added example AAS and included it in the documentation with brief disclaimers. --------- Co-authored-by: Michael Jacoby <[email protected]>
FraunhoferIOSB · Oct 10, 2024 · 4e06fce · 4e06fce
1 parent d743d75
commit 4e06fce
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -9,6 +9,7 @@
 *.java text eol=crlf
 
 # Denote all files that are truly binary and should not be modified.
+*.aasx binary
 *.png binary
 *.jpg binary
 *.jpeg binary

diff --git a/docs/source/aas-examples/Example_AAS.aasx b/docs/source/aas-examples/Example_AAS.aasx
diff --git a/docs/source/basics/usage.md b/docs/source/basics/usage.md
@@ -16,6 +16,11 @@ To manually pass a model file `my-model.aasx` and a configuration file `my-confi
 > java -jar starter-{version}.jar --model my-model.aasx --config my-config.json
 ```
 
+An example model file can be found in the [FA³ST Github-Repository](https://github.com/FraunhoferIOSB/FAAAST-Service/blob/main/docs/source/aas-examples/example-aas.aasx).
+Regarding AAS examples from other sources it is important to note that the AAS specification is not backwards compatible. Therefore, it is necessary to make sure that the model file conforms to the latest AAS specification (V3).
+Passing an outdated model file will lead to an error. If a model file conforms to V3 of the Asset Administration Shell specification but has duplicate identifiers, FA³ST will not load the file.
+Starting FA³ST with the `--no-validation` flag loads the file in any case but will lead to problems during runtime if there are duplicate identifiers present.
+
 :::{table} Supported CLI arguments and environment variables.
 | CLI (short)   | CLI (long)            | Environment variable                                           | Allowed<br>Values                       | Description                                                                                                                                              | Default<br>Value |
 | ------------- | --------------------- | -------------------------------------------------------------- | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |