Swagger file:training job for TM 40/13640/1
authorSwaraj Kumar <swaraj.kumar@samsung.com>
Fri, 18 Oct 2024 05:05:57 +0000 (10:35 +0530)
committerSwaraj Kumar <swaraj.kumar@samsung.com>
Fri, 18 Oct 2024 05:05:57 +0000 (10:35 +0530)
Change-Id: I6915fbd3a990b61ed6ae0f4b146502b98c47ba57
Signed-off-by: Swaraj Kumar <swaraj.kumar@samsung.com>
API_docs/training-manager.yaml

index 3258c5c..a577bca 100644 (file)
@@ -20,4 +20,97 @@ tags:
   - name: Pipeline
     description: Pipeline related operations
   - name: Training Job
-    description: Training Job related operations
\ No newline at end of file
+    description: Training Job related operations
+
+paths:
+  /trainingjobs/{trainingjob_name}/{version}:
+    get:
+      tags:
+        - Training Job
+      summary: "Fetch training job details by name and version"
+      description: "Returns detailed information about a specific training job identified by its name and version."
+      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 training job details"
+          schema:
+            type: "object"
+            properties:
+              trainingjob:
+                type: "object"
+                properties:
+                  trainingjob_name:
+                    type: "string"
+                  description:
+                    type: "string"
+                  feature_list:
+                    type: "string"
+                  pipeline_name:
+                    type: "string"
+                  experiment_name:
+                    type: "string"
+                  arguments:
+                    type: "object"
+                  query_filter:
+                    type: "string"
+                  creation_time:
+                    type: "string"
+                    format: "date-time"
+                  run_id:
+                    type: "string"
+                  steps_state:
+                    type: "object"
+                  accuracy:
+                    type: "string"
+                  enable_versioning:
+                    type: "boolean"
+                  updation_time:
+                    type: "string"
+                    format: "date-time"
+                  version:
+                    type: "integer"
+                  pipeline_version:
+                    type: "string"
+                  datalake_source:
+                    type: "string"
+                  model_url:
+                    type: "string"
+                  notification_url:
+                    type: "string"
+                  is_mme:
+                    type: "boolean"
+                  model_name:
+                    type: "string"
+                  model_info:
+                    type: "string"
+        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"
\ No newline at end of file