update documentation for CRUD operations

eclipse-esmf · Jun 11, 2024 · b518bbb · b518bbb
1 parent 5af79d4
commit b518bbb
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/documentation/ame-guide/modules/ROOT/images/generation/open-api-dialog.png b/documentation/ame-guide/modules/ROOT/images/generation/open-api-dialog.png
diff --git a/...n/ame-guide/modules/ROOT/images/generation/open-api-spec-with-resource-path.png b/...n/ame-guide/modules/ROOT/images/generation/open-api-spec-with-resource-path.png
diff --git a/documentation/ame-guide/modules/ROOT/pages/generate/generate-openapi-doc.adoc b/documentation/ame-guide/modules/ROOT/pages/generate/generate-openapi-doc.adoc
@@ -6,6 +6,9 @@ To generate an OpenAPI specification from the Aspect Model, proceed as follows:
 +
 image:generation/open-api-spec.png[Generate document, width=20%]
 
+The generate OpenAPI dialog will open:
+image:generation/open-api-dialog.png[Generate OpenAPI document, width=50%, link=self]
+
 * In case your model supports multiple languages, select the specific language for the documentation.
 * Select *JSON* or *YAML* in the *Output file format* drop-down.
 * Set the base URL where the Aspect API will be served from.
@@ -16,6 +19,8 @@ image:generation/open-api-spec.png[Generate document, width=20%]
 * Select the *Include Query API* checkbox, if you need a path section for the Query API Endpoint of the Aspect API to be included in the specification.
 * Select the *Use Semantic Version* checkbox, if you need the complete semantic version of the Aspect Model to be used as the version of the API. Otherwise, only the major part of the Aspect Version is used as the version of the API.
 * Select the *Active Resource Path* checkbox, if you need the active resource path to be included in the specification.
+* Select the *Include CRUD* checkbox, if you need the CRUD backend functionality.
+* Select the *Include POST*, *Include PUT*, *Include PATCH* checkboxes, if you need the corresponding backend functionality.
 * Click *Generate* and store the OpenAPI specification file locally.
 
 [[resource-path]]
@@ -30,7 +35,7 @@ The inclusion of certain properties in the output depends on the selected output
 It is crucial to ensure that the properties in the file match those specified in the resource path.
 Failure to do so will result in an error prompting a review of the mismatches.
 
-image:generation/open-api-dialog.png[Generate OpenAPI document, width=50%, link=self]
+image:generation/open-api-spec-with-resource-path.png[Generate OpenAPI document, width=50%, link=self]
 
 TIP: If you run into errors, please make sure that the graph is valid. +
 If the invalid element is not highlighted with a red border, click the Validate icon to get a hint.