From 69961f8bf3da4f2e33309acf6862a7fec668d857 Mon Sep 17 00:00:00 2001
From: Marcel Becker <stu117960@mail.uni-kiel.de>
Date: Thu, 24 Feb 2022 16:13:34 +0100
Subject: [PATCH] Updated Api-reference page according to the execution yaml
file
---
docs/api-reference/crds.md | 82 +++++++++++++++++++-------------------
1 file changed, 41 insertions(+), 41 deletions(-)
diff --git a/docs/api-reference/crds.md b/docs/api-reference/crds.md
index 9ee24e17c..782252bca 100644
--- a/docs/api-reference/crds.md
+++ b/docs/api-reference/crds.md
@@ -1764,6 +1764,13 @@ Contains the Kafka configuration.
Defines the overall parameter for the execution.<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>true</td>
</tr><tr>
<td><b><a href="#executionspecresources">resources</a></b></td>
<td>object</td>
@@ -1778,13 +1785,6 @@ 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>true</td>
</tr><tr>
<td><b>name</b></td>
<td>string</td>
@@ -1982,6 +1982,40 @@ Defines the used strategy for the execution, either 'LinearSearch', 'BinarySearc
</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.spec.resources
<sup><sup>[↩ Parent](#executionspec)</sup></sup>
@@ -2066,40 +2100,6 @@ 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