Merge pull request #106 from modelix/docs/add-model-api

MODELIX-2: Add initial model-api documentation

Author: mhuster23

docs/global/modules/core/images/model-api.api.png

@@ -11,7 +11,7 @@ https://github.com/modelix/modelix.core[Repository^] | https://github.com/modeli
 
 In order to export a meta-model (i.e. the structure aspect of a langauge) from MPS, modelix uses the MPS solution `metamodel-export`.
 This solution maps the structure of a language to corresponding serializable data classes of the https://api.modelix.org/2.3.0/model-api/org.modelix.model.data/index.html[`model-api`] (e.g. `LanguageData` and `ConcepData`).
-Further, the `metamodel-expor` provides a command line interface to export these data classes to a JSON file from outside of MPS.
+Further, the `metamodel-export` provides a command line interface to export these data classes to a JSON file from outside of MPS.
 
 
 

docs/global/modules/core/images/model-api.data.metamodel.png

@@ -1,7 +1,6 @@
 = Gradle Plugin for the Model API Generator
 :navtitle: `model-api-gen-gradle`
 
-
 :tip-caption: 🔗 Quick Links
 [TIP]
 --

docs/global/modules/core/images/model-api.data.model.png

@@ -0,0 +1,59 @@
+= Model API
+:navtitle: `model-api`
+
+
+:tip-caption: 🔗 Quick Links
+[TIP]
+--
+https://api.modelix.org/2.3.0/model-api/index.html[API doc^] | https://github.com/modelix/modelix.core[Repository^] | https://github.com/modelix/modelix.core/blob/main/model-api/build.gradle.kts[buildfile^]
+--
+
+:tip-caption: 🔗 Artifacts
+[TIP]
+--
+`org.modelix.model-api`: https://artifacts.itemis.cloud/service/rest/repository/browse/maven-mps/org/modelix/model-api/[Nexus^] https://github.com/modelix/modelix.core/packages/1834768[GitHub Packages^]
+
+// TODO `org.modelix.model-api-jvm`:
+
+// TODO `org.modelix.model-api-js`:
+--
+
+
+== Overview
+
+The *Model API* (`model-api`) is a Kotlin component which provides a metamodel independent model API.
+This API is the shared basis and used across all modelix components.
+
+
+The `model-api` provides three distinct parts
+
+1. `org.modelix.model.api`: The untyped API to provide model access
+2. `org.modelix.model.data`: Data classes for (meta-)model serialization
+3. `org.modelix.model.area`: Model grouping and transactional access
+
+
+=== 1. `org.modelix.model.api`
+
+The following diagram provides a meta-model of the `model-api`
+
+image::model-api.api.png[]
+
+An **untyped** access to model content is possible when only using the `model-api`.
+In case you want to use domain-specific model access (i.e. **typed** access), the xref:core:reference/component-model-api-gen.adoc[model-api-gen] provides a generator which generates a typed model API from your existing meta-model.
+This generated API specializes the `model-api`.
+
+
+=== 2.`org.modelix.model.data`
+
+Additionally, the `model-api` provides serializable data classes to represent a meta-model.
+The following diagrams show a class diagram of the data classes for the model and meta-model.
+
+[cols="a,a", frame=none, grid=none]
+|===
+| image::model-api.data.model.png[width=69%]
+| image::model-api.data.metamodel.png[]
+|===
+
+
+//=== 3. `org.modelix.model.area`
+//TODO

docs/global/modules/core/pages/reference/component-metamodel-export.adoc

@@ -1,3 +1,4 @@
+* xref:core:reference/component-model-api.adoc[]
 * xref:core:reference/component-model-server.adoc[]
 * xref:core:reference/component-metamodel-export.adoc[]
 * xref:core:reference/component-model-api-gen.adoc[]