aboutsummaryrefslogtreecommitdiffstats
path: root/docs/clamp/acm/acm-user-guide.rst
diff options
context:
space:
mode:
authorFrancescoFioraEst <francesco.fiora@est.tech>2023-08-04 14:00:54 +0100
committerFrancesco Fiora <francesco.fiora@est.tech>2023-08-08 10:14:28 +0000
commitb12c67854c70ae410e02af501126ecf8434e5dd9 (patch)
tree17a6a64d2275c47c9b205f088394b4937292f9f5 /docs/clamp/acm/acm-user-guide.rst
parent4f1c3755a6e13086693f8ce56cce5358211d749a (diff)
Add documentation of participant composition properties
Issue-ID: POLICY-4779 Change-Id: I67ddb8541aa0cfd198d4bd84414b56b59bc1a594 Signed-off-by: FrancescoFioraEst <francesco.fiora@est.tech>
Diffstat (limited to 'docs/clamp/acm/acm-user-guide.rst')
-rwxr-xr-x[-rw-r--r--]docs/clamp/acm/acm-user-guide.rst44
1 files changed, 41 insertions, 3 deletions
diff --git a/docs/clamp/acm/acm-user-guide.rst b/docs/clamp/acm/acm-user-guide.rst
index 2ed49176..0a033b50 100644..100755
--- a/docs/clamp/acm/acm-user-guide.rst
+++ b/docs/clamp/acm/acm-user-guide.rst
@@ -337,7 +337,9 @@ Functionality covered:
#. Set participantId and supportedElementType by properties file or by parameter environment.
#. Set a delay for each operation at runtime by Rest-Api.
#. Set success or fail for each operation at runtime by Rest-Api.
-#. update useState, operationalState and outPropeties and send to ACM-runtime by Rest-Api.
+#. update composition outProperties and send to ACM-runtime by Rest-Api.
+#. read all AC Definition inProperties/outProperties information by Rest-Api.
+#. update useState, operationalState and outProperties and send to ACM-runtime by Rest-Api.
#. read all AC instance elements information by Rest-Api.
Mock a participant using docker-compose
@@ -388,8 +390,44 @@ The Json below is an example of configuration:
"deprimeTimerMs": 100
}
-Update and send useState operationalState and outProperites
------------------------------------------------------------
+Update and send composition outProperites
+-----------------------------------------
+Data like useState operationalState and outProperites could be updated any time using the following endpoint:
+
+.. code-block:: bash
+
+ Invoke a PUT request 'http://participant_sim_ip:port/onap/policy/clamp/acm/simparticipant/v2/compositiondatas'
+
+The Json below is an example of update, where {{compositionId}} is the UUID of the AC Definition
+and ("onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement", "1.2.3") is the ToscaConceptIdentifier of the AC Definition element:
+
+.. code-block:: json
+
+ {
+ "outProperties": {
+ "list": [
+ {"id": 10 },
+ {"id": 20 }
+ ]
+ },
+ "compositionId": "{{compositionId}}",
+ "compositionDefinitionElementId": {
+ "name": "onap.policy.clamp.ac.element.Http_BridgeAutomationCompositionElement",
+ "version": "1.2.3"
+ }
+ }
+
+Read all AC Definition elements information
+-------------------------------------------
+All AC Definition elements information like composition inProperties and outProperties
+could be read using the following endpoint:
+
+.. code-block:: bash
+
+ Invoke a GET request 'http://participant_sim_ip:port/onap/policy/clamp/acm/simparticipant/v2/compositiondatas'
+
+Update and send useState operationalState and instance outProperites
+--------------------------------------------------------------------
Data like useState operationalState and outProperites could be updated any time using the following endpoint:
.. code-block:: bash