docs: Runtime Defined Entity Behaviors Part 1

This commit contains Behaviors general concepts, invocation. Signed-off-by: kirilkadoncheva <kiki.doncheva393@gmail.com>
vmware · Jun 11, 2024 · d3fb062 · d3fb062
1 parent a2bce39
commit d3fb062
Show file tree

Hide file tree

Showing 13 changed files with 481 additions and 0 deletions.
diff --git a/documentation/extensibility-platform/defined-entities/aws-lambda-behaviors.md b/documentation/extensibility-platform/defined-entities/aws-lambda-behaviors.md
@@ -0,0 +1 @@
+# AWS Lambda Behaviors
diff --git a/...mentation/extensibility-platform/defined-entities/behaviors-general-concepts.md b/...mentation/extensibility-platform/defined-entities/behaviors-general-concepts.md
diff --git a/documentation/extensibility-platform/defined-entities/mqtt-behaviors.md b/documentation/extensibility-platform/defined-entities/mqtt-behaviors.md
@@ -0,0 +1,2 @@
+# MQTT Behaviors
+
diff --git a/documentation/extensibility-platform/defined-entities/no-op-behaviors.md b/documentation/extensibility-platform/defined-entities/no-op-behaviors.md
@@ -0,0 +1,60 @@
+# No-op Behaviors
+
+No-op behaviors, as the name suggests, are behaviors which do not perform any operation as part of their execution. They always succeed or always fail (depending on how they are configured). This type of behaviors can be used for testing purposes.
+
+## Behavior Definition
+The no-op behavior execution type is `noop`. By default no-op behavior execution always succeeds and returns a `null` result. However, a no-op behavior can be configured to return a custom result. Also no-op behaviors can be configured to always fail with custom error.
+
+#### Special execution properties
+There are some special properties which can be set in the behavior definition `execution_properties` section.
+- `returnValue` - any - this property is used to set a custom result value for the behavior.
+- `returnError` - Object - this property is used to set a custom error for the behavior:
+    ```json
+    "returnError": {
+                "majorErrorCode": 501,
+                "minorErrorCode": "NOT_IMPLEMENTED",
+                "message": "Not Implemented"
+            }
+    ```
+
+Default no-op behavior definition:
+```json 
+{
+    "name": "testNoOp",
+    "execution": {
+        "type": "noop"
+    }
+}
+```
+
+No-op behavior definition returning custom result:
+
+```json
+{
+    "name": "testNoOpWithReturnArgument",
+    "execution": {
+        "type": "noop",
+        "execution_properties": {
+            "returnValue": "Successful Behavior Execution"
+        }
+    }
+}
+```
+
+No-op behavior definition for behavior failing with custom error:
+```json
+{
+
+    "name": "testNoOpError",
+    "execution": {
+        "type": "noop",
+        "execution_properties": {
+            "returnError": {
+                "majorErrorCode": 501,
+                "minorErrorCode": "NOT_IMPLEMENTED",
+                "message": "Not Implemented"
+            }
+        }
+    }
+}
+```
diff --git a/documentation/extensibility-platform/defined-entities/vro-behaviors.md b/documentation/extensibility-platform/defined-entities/vro-behaviors.md
@@ -0,0 +1 @@
+# VRO Behaviors
diff --git a/documentation/extensibility-platform/defined-entities/webhook-behaviors.md b/documentation/extensibility-platform/defined-entities/webhook-behaviors.md
@@ -0,0 +1 @@
+# WebHook Behaviors
diff --git a/documentation/images/rde-multi-stage-delete-async-1.png b/documentation/images/rde-multi-stage-delete-async-1.png
diff --git a/documentation/images/rde-multi-stage-delete-async-2.png b/documentation/images/rde-multi-stage-delete-async-2.png
diff --git a/documentation/images/rde-multi-stage-delete-sync-1.png b/documentation/images/rde-multi-stage-delete-sync-1.png
diff --git a/documentation/images/rde-multi-stage-delete-sync-2.png b/documentation/images/rde-multi-stage-delete-sync-2.png
diff --git a/documentation/images/rde-post-create-hook-entity-states.png b/documentation/images/rde-post-create-hook-entity-states.png
diff --git a/documentation/images/rde-sync-deletion-entity-states-1.png b/documentation/images/rde-sync-deletion-entity-states-1.png
diff --git a/documentation/images/rde-sync-deletion-entity-states-2.png b/documentation/images/rde-sync-deletion-entity-states-2.png