Swagger file:training step states job for TM 41/13641/1
authorSwaraj Kumar <swaraj.kumar@samsung.com>
Fri, 18 Oct 2024 05:07:15 +0000 (10:37 +0530)
committerSwaraj Kumar <swaraj.kumar@samsung.com>
Fri, 18 Oct 2024 05:07:15 +0000 (10:37 +0530)
Change-Id: I2ddee852f5d507ebf716839366d26fbadd3ee630
Signed-off-by: Swaraj Kumar <swaraj.kumar@samsung.com>
API_docs/training-manager.yaml

index a577bca..19defdc 100644 (file)
@@ -113,4 +113,49 @@ paths:
             type: "object"
             properties:
               Exception:
-                type: "string"
\ No newline at end of file
+                type: "string"
+
+  /trainingjobs/{trainingjob_name}/{version}/steps_state:
+    get:
+      tags:
+        - Training Job
+      summary: "Get steps state information for a training job"
+      description: "Returns the state of each step in the training job process."
+      parameters:
+        - name: "trainingjob_name"
+          in: "path"
+          required: true
+          type: "string"
+          description: "Name of the training job"
+        - name: "version"
+          in: "path"
+          required: true
+          type: "integer"
+          description: "Version of the training job"
+      responses:
+        200:
+          description: "Successful response with steps state information"
+          schema:
+            type: "object"
+        400:
+          description: "Invalid training job name or version"
+          schema:
+            type: "object"
+            properties:
+              Exception:
+                type: "string"
+        404:
+          description: "Training job not found"
+          schema:
+            type: "object"
+            properties:
+              Exception:
+                type: "string"
+        500:
+          description: "Internal server error"
+          schema:
+            type: "object"
+            properties:
+              Exception:
+                type: "string"
+