diff options
author | FrancescoFioraEst <francesco.fiora@est.tech> | 2023-08-04 14:00:54 +0100 |
---|---|---|
committer | Ramesh Murugan Iyer <ramesh.murugan.iyer@est.tech> | 2023-08-09 10:26:36 +0000 |
commit | d6e811f962b63bc78d1e8e4243fe2ed94d9992c4 (patch) | |
tree | 17a6a64d2275c47c9b205f088394b4937292f9f5 /docs/clamp/acm/acm-user-guide.rst | |
parent | a67a3533a3760939b53114c0f442685a7535670f (diff) |
Add documentation of participant composition properties
Issue-ID: POLICY-4779
Change-Id: I67ddb8541aa0cfd198d4bd84414b56b59bc1a594
Signed-off-by: FrancescoFioraEst <francesco.fiora@est.tech>
(cherry picked from commit b12c67854c70ae410e02af501126ecf8434e5dd9)
Diffstat (limited to 'docs/clamp/acm/acm-user-guide.rst')
-rwxr-xr-x[-rw-r--r--] | docs/clamp/acm/acm-user-guide.rst | 44 |
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 |