doc: add set run description and title api documentation HYB-646

Motivation: Users can set run title and description from the API.
gatling · Jul 1, 2024 · d961570 · d961570
1 parent a3f70cf
commit d961570
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/openapi/src/main/openapi/simulation/components.yaml b/openapi/src/main/openapi/simulation/components.yaml
@@ -27,12 +27,16 @@ requests:
                 "c800b6d9-163b-3db7-928f-86c1470a9542":
                   size: 1
                   weight: 40
+              title: "My run title"
+              description: "My run description"
           SimulationWithPrivateLocations:
             value:
               extraSystemProperties:
                 customProperty: "value"
               extraEnvironmentVariables:
                 customProperty: "value"
+              title: "My run title"
+              description: "My run description"
 
   Simulation:
     description: The definition of a simulation
@@ -187,6 +191,14 @@ schemas:
         $ref: '../common/components.yaml#/schemas/CustomDictionary'
       overrideHostsByPool:
         $ref: '#/schemas/HostsByPool'
+      title:
+        type: string
+        description: "Run title"
+        example: "My run title"
+      description:
+        type: string
+        description: "Run description"
+        example: "My run description"
 
   ClassName:
     type: object