From 16d5f2e1292ebea408e0a747835adc93d686c253 Mon Sep 17 00:00:00 2001
From: Marcel Becker <stu117960@mail.uni-kiel.de>
Date: Sun, 20 Feb 2022 16:16:05 +0100
Subject: [PATCH] actually updated api-reference page
---
docs/api-reference/crds.md | 100 +++++++++++++++++++++++++++----------
1 file changed, 74 insertions(+), 26 deletions(-)
diff --git a/docs/api-reference/crds.md b/docs/api-reference/crds.md
index 238c98731..f7a3185f5 100644
--- a/docs/api-reference/crds.md
+++ b/docs/api-reference/crds.md
@@ -1764,13 +1764,6 @@ Contains the Kafka configuration.
Defines the overall parameter for the execution.<br/>
</td>
<td>true</td>
- </tr><tr>
- <td><b><a href="#executionspecload">load</a></b></td>
- <td>object</td>
- <td>
- Specifies the load values that are benchmarked.<br/>
- </td>
- <td>true</td>
</tr><tr>
<td><b><a href="#executionspecresources">resources</a></b></td>
<td>object</td>
@@ -1785,6 +1778,13 @@ Contains the Kafka configuration.
List of resource values for the specified resource type.<br/>
</td>
<td>true</td>
+ </tr><tr>
+ <td><b><a href="#executionspecloads">loads</a></b></td>
+ <td>object</td>
+ <td>
+ Specifies the load values that are benchmarked.<br/>
+ </td>
+ <td>false</td>
</tr><tr>
<td><b>name</b></td>
<td>string</td>
@@ -1910,17 +1910,10 @@ Defines the overall parameter for the execution.
</td>
<td>true</td>
</tr><tr>
- <td><b>restrictions</b></td>
- <td>[]string</td>
- <td>
- List of restriction strategies used to delimit the search space.<br/>
- </td>
- <td>false</td>
- </tr><tr>
- <td><b>strategy</b></td>
- <td>string</td>
+ <td><b><a href="#executionspecexecutionstrategy">strategy</a></b></td>
+ <td>object</td>
<td>
- Defines the used strategy for the execution, either 'LinearSearch' or 'BinarySearch'<br/>
+ Defines the used strategy for the execution, either 'LinearSearch', 'BinarySearch' or 'InitialGuessSearch'.<br/>
</td>
<td>true</td>
</tr><tr>
@@ -1930,16 +1923,23 @@ Defines the overall parameter for the execution.
Seconds to wait between the start of the SUT and the load generator.<br/>
</td>
<td>false</td>
+ </tr><tr>
+ <td><b>metric</b></td>
+ <td>string</td>
+ <td>
+ <br/>
+ </td>
+ <td>false</td>
</tr></tbody>
</table>
-### execution.spec.load
-<sup><sup>[↩ Parent](#executionspec)</sup></sup>
+### execution.spec.execution.strategy
+<sup><sup>[↩ Parent](#executionspecexecution)</sup></sup>
-Specifies the load values that are benchmarked.
+Defines the used strategy for the execution, either 'LinearSearch', 'BinarySearch' or 'InitialGuessSearch'.
<table>
<thead>
@@ -1951,19 +1951,33 @@ Specifies the load values that are benchmarked.
</tr>
</thead>
<tbody><tr>
- <td><b>loadType</b></td>
+ <td><b>name</b></td>
<td>string</td>
<td>
- The type of the load. It must match one of the load types specified in the referenced benchmark.<br/>
+ <br/>
</td>
<td>true</td>
</tr><tr>
- <td><b>loadValues</b></td>
- <td>[]integer</td>
+ <td><b>guessStrategy</b></td>
+ <td>string</td>
<td>
- List of load values for the specified load type.<br/>
+ <br/>
</td>
- <td>true</td>
+ <td>false</td>
+ </tr><tr>
+ <td><b>restrictions</b></td>
+ <td>[]string</td>
+ <td>
+ List of restriction strategies used to delimit the search space.<br/>
+ </td>
+ <td>false</td>
+ </tr><tr>
+ <td><b>searchStrategy</b></td>
+ <td>string</td>
+ <td>
+ <br/>
+ </td>
+ <td>false</td>
</tr></tbody>
</table>
@@ -2052,6 +2066,40 @@ Specifies the scaling resource that is benchmarked.
</table>
+### execution.spec.loads
+<sup><sup>[↩ Parent](#executionspec)</sup></sup>
+
+
+
+Specifies the load values that are benchmarked.
+
+<table>
+ <thead>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ </thead>
+ <tbody><tr>
+ <td><b>loadType</b></td>
+ <td>string</td>
+ <td>
+ The type of the load. It must match one of the load types specified in the referenced benchmark.<br/>
+ </td>
+ <td>true</td>
+ </tr><tr>
+ <td><b>loadValues</b></td>
+ <td>[]integer</td>
+ <td>
+ List of load values for the specified load type.<br/>
+ </td>
+ <td>true</td>
+ </tr></tbody>
+</table>
+
+
### execution.status
<sup><sup>[↩ Parent](#execution)</sup></sup>
--
GitLab