#384 Add documentation

sngular · Oct 25, 2023 · 1b58369 · 1b58369
1 parent e78d570
commit 1b58369
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 0 deletions.
diff --git a/docs/_Sidebar.md b/docs/_Sidebar.md
@@ -16,6 +16,7 @@
   - [Consumer configuration](consumer-configuration.md)
   - [Schemas](schemas.md)
   - [Schema Registry](schema-registry.md)
+  - [Asyncapi support](asyncapi.md)
 
 # Knowledge center
   - [How to run a test plan](how-to-run.md)

diff --git a/docs/asyncapi.md b/docs/asyncapi.md
@@ -0,0 +1,22 @@
+# Asyncapi Support
+
+Here you can find the way to use your asyncapi.yml definition to produce a performance load test.
+The only requirement is to use the AsyncApi Sampler component. There you can load the asyncapi file into the plugin.
+
+![AsyncApi Component](images/AsyncapiComponent.png)
+
+Once the file is loaded, information will appear in the elements below.
+First tab you can see the broker configuration where you can choose to which broker you want to connect to.
+
+![Broker Selection](images/AsyncApiComponent-ComboBroker.png)
+
+Once the broker has been choose the data will be loaded. By default the first server configuration will be selected
+
+![Developemnt Broker](images/AsyncApiComponent-FileLoaded.png)
+
+In order to choose which payload you want to use for the test just move to the second tab and use the combo to select which topic you want to use. 
+As for in AsyncApi specification channel/topic contains the payload will be transmitted.
+
+![Payload configuration](images/AsyncApiComponent-SchemaLoaded.png)
+
+Data generation use the same engine than the rest of the samplers so information from [schemas page](schemas.md) applu
diff --git a/docs/images/AsyncApiComponent-ComboBroker.png b/docs/images/AsyncApiComponent-ComboBroker.png
diff --git a/docs/images/AsyncApiComponent-FileLoaded.png b/docs/images/AsyncApiComponent-FileLoaded.png
diff --git a/docs/images/AsyncApiComponent-SchemaLoaded.png b/docs/images/AsyncApiComponent-SchemaLoaded.png
diff --git a/docs/images/AsyncapiComponent.png b/docs/images/AsyncapiComponent.png