From: Swaraj Kumar <swaraj.kumar@samsung.com>
Date: Fri, 18 Oct 2024 05:24:42 +0000 (+0530)
Subject: Swagger file:put and put training job for TM
X-Git-Tag: 3.0.0~71
X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=fda1fd731b1e9cd3696e828799395dc36a48ae49;p=aiml-fw%2Fawmf%2Ftm.git

Swagger file:put and put training job for TM

Change-Id: I4242aaa7a254462cbe484a2c18976452bd228631
Signed-off-by: Swaraj Kumar <swaraj.kumar@samsung.com>
---

diff --git a/API_docs/training-manager.yaml b/API_docs/training-manager.yaml
index a58cefc..13cdca8 100644
--- a/API_docs/training-manager.yaml
+++ b/API_docs/training-manager.yaml
@@ -458,4 +458,146 @@ paths:
             properties:
               Exception:
                 type: "string"
-                
+
+  /trainingjobs/{trainingjob_name}:
+    post:
+      tags:
+        - Training Job
+      summary: "Create a new training job"
+      description: "Creates a new training job with the provided details."
+      parameters:
+        - name: "trainingjob_name"
+          in: "path"
+          required: true
+          type: "string"
+          description: "Name of the training job"
+        - name: "body"
+          in: "body"
+          required: true
+          schema:
+            type: "object"
+            properties:
+              description:
+                type: "string"
+              featuregroup_name:
+                type: "string"
+              pipeline_name:
+                type: "string"
+              experiment_name:
+                type: "string"
+              arguments:
+                type: "object"
+              query_filter:
+                type: "string"
+              enable_versioning:
+                type: "boolean"
+              pipeline_version:
+                type: "string"
+              datalake_source:
+                type: "string"
+              _measurement:
+                type: "string"
+              bucket:
+                type: "string"
+              is_mme:
+                type: "boolean"
+              model_name:
+                type: "string"
+      responses:
+        201:
+          description: "Training job created successfully"
+          schema:
+            type: "object"
+            properties:
+              result:
+                type: "string"
+        400:
+          description: "Invalid training job name or data"
+          schema:
+            type: "object"
+            properties:
+              Exception:
+                type: "string"
+        409:
+          description: "Training job name already exists"
+          schema:
+            type: "object"
+            properties:
+              Exception:
+                type: "string"
+        500:
+          description: "Internal server error"
+          schema:
+            type: "object"
+            properties:
+              Exception:
+                type: "string"
+
+    put:
+      tags:
+        - Training Job
+      summary: "Update an existing training job"
+      description: "Updates an existing training job with the provided details. Precondition: the training job's overall status should be failed or finished, and no deletion process should be in progress."
+      parameters:
+        - name: "trainingjob_name"
+          in: "path"
+          required: true
+          type: "string"
+          description: "Name of the training job"
+        - name: "body"
+          in: "body"
+          required: true
+          schema:
+            type: "object"
+            properties:
+              description:
+                type: "string"
+              featuregroup_name:
+                type: "string"
+              pipeline_name:
+                type: "string"
+              experiment_name:
+                type: "string"
+              arguments:
+                type: "object"
+              query_filter:
+                type: "string"
+              enable_versioning:
+                type: "boolean"
+              pipeline_version:
+                type: "string"
+              datalake_source:
+                type: "string"
+              is_mme:
+                type: "boolean"
+              model_name:
+                type: "string"
+      responses:
+        200:
+          description: "Training job updated successfully"
+          schema:
+            type: "object"
+            properties:
+              result:
+                type: "string"
+        400:
+          description: "Invalid training job name or data"
+          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"