summaryrefslogtreecommitdiffstats
path: root/docs/clamp/acm/design-impl/participants/participant-simulator.rst
diff options
context:
space:
mode:
authoradheli.tavares <adheli.tavares@est.tech>2022-03-31 10:31:36 +0100
committeradheli.tavares <adheli.tavares@est.tech>2022-03-31 10:32:07 +0100
commit96f544440333fb59fcc45fb9f53346e2320bc9bb (patch)
tree32584ae289aeb76dd416d8c7299af61a0e57e00d /docs/clamp/acm/design-impl/participants/participant-simulator.rst
parent178dea1eb3eb979994d8b99f317f536b85435b60 (diff)
Reestructuring the clamp doc tree
Issue-ID: POLICY-3941 Change-Id: I116742a732789a2737a00250849914aa30ad2fbf Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
Diffstat (limited to 'docs/clamp/acm/design-impl/participants/participant-simulator.rst')
-rw-r--r--docs/clamp/acm/design-impl/participants/participant-simulator.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/clamp/acm/design-impl/participants/participant-simulator.rst b/docs/clamp/acm/design-impl/participants/participant-simulator.rst
new file mode 100644
index 00000000..9ac4e735
--- /dev/null
+++ b/docs/clamp/acm/design-impl/participants/participant-simulator.rst
@@ -0,0 +1,21 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+.. _clamp-controlloop-participant-simulator:
+
+Participant Simulator
+#####################
+
+This can be used for simulation testing purpose when there are no actual frameworks or a full deployment.
+Participant simulator can edit the states of ControlLoopElements and Participants for verification of other controlloop components
+for early testing.
+All controlloop components should be setup, except participant frameworks (for example, no policy framework components
+are needed) and participant simulator acts as respective participant framework, and state changes can be done with following REST APIs
+
+Participant Simulator API
+=========================
+
+This API allows a Participant Simulator to be started and run for test purposes.
+
+:download:`Download Policy Participant Simulator API Swagger <swagger/participant-sim.json>`
+
+.. swaggerv2doc:: swagger/participant-sim.json