aboutsummaryrefslogtreecommitdiffstats
path: root/docs/clamp/controlloop/design-impl/participants/participant-simulator.rst
diff options
context:
space:
mode:
authorSirisha_Manchikanti <sirisha.manchikanti@est.tech>2021-10-19 13:16:02 +0100
committerSirisha Manchikanti <sirisha.manchikanti@est.tech>2021-10-19 14:12:50 +0000
commit0f40950baa6a423aad590e8c964468f34c6582f7 (patch)
tree6b73d9541d1907bb3aaa7f3728ccb9cd98bea07d /docs/clamp/controlloop/design-impl/participants/participant-simulator.rst
parent848f998f8b45b25584444b3329cef80f430a458c (diff)
Add docs for participant intermediary, simulator
This commit contains docs for participant intermediary, participant simulator and respective smoke tests Issue-ID: POLICY-3716 Signed-off-by: Sirisha_Manchikanti <sirisha.manchikanti@est.tech> Change-Id: I72f658d39a3afeab643f680981ab73354418a26c
Diffstat (limited to 'docs/clamp/controlloop/design-impl/participants/participant-simulator.rst')
-rw-r--r--docs/clamp/controlloop/design-impl/participants/participant-simulator.rst15
1 files changed, 14 insertions, 1 deletions
diff --git a/docs/clamp/controlloop/design-impl/participants/participant-simulator.rst b/docs/clamp/controlloop/design-impl/participants/participant-simulator.rst
index 8f59a9f1..9ac4e735 100644
--- a/docs/clamp/controlloop/design-impl/participants/participant-simulator.rst
+++ b/docs/clamp/controlloop/design-impl/participants/participant-simulator.rst
@@ -5,4 +5,17 @@
Participant Simulator
#####################
-To be completed.
+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