cont

openapi/archive/s3_endpoints.yaml

@@ -0,0 +1,137 @@
+# openapi: "3.0.0"
+# info:
+#   title: DLP API
+#   description: API endpoints for the Deep Learning Playground Project
+#   version: "1.0.0"
+# paths:
+#   /api/s3/getSignedUploadUrl:
+#     post:
+#       description: Endpoint to upload files to S3
+#       requestBody:
+#         content:
+#           application/json:
+#             schema:
+#               type: object
+#               required:
+#                 - version
+#                 - filename
+#                 - file
+#               properties:
+#                 version:
+#                   type: integer
+#                   description: The file version
+#                 filename:
+#                   type: string
+#                   description: The name of the file
+#                 file:
+#                   type: object
+#                   description: the file
+#               example:
+#                 version: 2
+#                 filename: "file"
+#                 file: { "col1": [val1, val2], "col2": [val3, val4] }
+#         required: true
+#       responses:
+#         "200":
+#           description: Data uploaded successfully
+#           content:
+#             application/json:
+#               schema:
+#                 type: object
+#                 properties:
+#                   message:
+#                     type: string
+#                     example: "Upload successful"
+#         "400":
+#           description: Upload didn't go through successfully. This is usually something wrong with your code
+#         "401":
+#           description: User is not authenticated
+#           content:
+#             application/json:
+#               schema:
+#                 type: object
+#                 properties:
+#                   error:
+#                     type: string
+#                     example: "User is not authenticated"
+#   /api/s3/getExecutionsFilesPresignedUrls:
+#     post:
+#       description: API Endpoint to use S3 Presigned URLs to retrieve result files from S3 given an execution id
+#       requestBody:
+#         content:
+#           application/json:
+#             schema:
+#               type: object
+#               required:
+#                 - exec_id
+#               properties:
+#                 exec_id:
+#                   type: string
+#                   description: The execution id
+#               example:
+#                 exec_id: '1234'
+#         required: true
+#       responses:
+#         "200":
+#           description: Result files for your execution fetched successfully
+#           content:
+#             application/json:
+#               schema:
+#                 type: object
+#                 properties:
+#                   message:
+#                     type: string
+#                     example: "Result file fetch successful"
+#         "400":
+#           description: Result file fetch didn't go through successfully. This is usually something wrong with your code
+#         "401":
+#           description: User is not authenticated
+#           content:
+#             application/json:
+#               schema:
+#                 type: object
+#                 properties:
+#                   error:
+#                     type: string
+#                     example: "User is not authenticated"
+#   /api/s3/getUserDatasetFilesData:
+#     post: 
+#       description: API Endpoint to retrieve all user dataset files uploaded in S3
+#       requestBody:
+#         content:
+#           application/json:
+#             schema:
+#               type: object 
+#               required: 
+#                 - uid
+#                 - data_source 
+#               properties:
+#                 uid: 
+#                   type: string 
+#                   description: User ID 
+#                 data_source: 
+#                   type: string 
+#                   description: 'What type of training was the user running (eg: TABULAR, PRETRAINED, OBJECT_DETECTION, IMAGE, etc)'
+#       responses:
+#         "200":
+#           description: User Dataset files for user fetched successfully
+#           content:
+#             application/json:
+#               schema:
+#                 type: object
+#                 properties:
+#                   message:
+#                     type: string
+#                     example: "User Dataset file fetch successful"
+#         "400":
+#           description: User Dataset files for user wasn't fetched successfully. This is usually something wrong with your code
+#         "401":
+#           description: User is not authenticated
+#           content:
+#             application/json:
+#               schema:
+#                 type: object
+#                 properties:
+#                   error:
+#                     type: string
+#                     example: "User is not authenticated"

openapi/archive/test_endpoints.yaml

@@ -0,0 +1,20 @@
+# openapi: "3.0.0"
+# info:
+#   title: DLP API
+#   description: API endpoints for the Deep Learning Playground Project
+#   version: "1.0.0"
+# paths:
+#   /api/test:
+#     get:
+#       summary: A simple endpoint to test if our backend is alive
+#       responses:
+#         200: 
+#           description: Test Backend alive
+#           content:
+#             application/json:
+#               schema:
+#                 type: object
+#                 properties:
+#                   Status:
+#                     type: string 
+#                     example: "Backend is alive"

openapi/archive/trainspace_endpoints.yaml

@@ -0,0 +1,86 @@
+# openapi: "3.0.0"
+# info:
+#   title: DLP API
+#   description: API endpoints for the Deep Learning Playground Project
+#   version: "1.0.0"
+# paths:
+#   /api/trainspace/create-trainspace:
+#     post:
+#       description:  API Endpoint to create a "trainspace". Trainspace is a new concept/data structure we introduce to track user's training requests. Concept similar to execution_id.
+#       requestBody:
+#         content:
+#           application/json:
+#             schema:
+#               type: object
+#               required:
+#                 - uid
+#               properties:
+#                 uid:
+#                   type: string
+#                   description: User ID
+#               example:
+#                 uid: '1234'
+#         required: true
+#       responses:
+#         "200":
+#           description: Trainspace created successfully
+#           content:
+#             application/json:
+#               schema:
+#                 type: object
+#                 properties:
+#                   message:
+#                     type: string
+#                     example: "Trainspace Creation successful"
+#         "400":
+#           description: Trainspace Creation didn't go through successfully. This is usually something wrong with your code
+#         "401":
+#           description: User is not authenticated
+#           content:
+#             application/json:
+#               schema:
+#                 type: object
+#                 properties:
+#                   error:
+#                     type: string
+#                     example: "User is not authenticated"
+#   /api/trainspace/getTrainspaceData:
+#     post:
+#       description:  API Endpoint to identify all trainspaces for a given user id.
+#       requestBody:
+#         content:
+#           application/json:
+#             schema:
+#               type: object
+#               required:
+#                 - uid
+#               properties:
+#                 uid:
+#                   type: string
+#                   description: User ID
+#               example:
+#                 uid: '1234'
+#         required: true
+#       responses:
+#         "200":
+#           description: Able to query and retrieve trainspace objects belonging to a user
+#           content:
+#             application/json:
+#               schema:
+#                 type: object
+#                 properties:
+#                   message:
+#                     type: string
+#                     example: "Trainspace Retrieval Successful"
+#         "400":
+#           description: Trainspace Retrieval didn't go through successfully. This is usually something wrong with your code
+#         "401":
+#           description: User is not authenticated
+#           content:
+#             application/json:
+#               schema:
+#                 type: object
+#                 properties:
+#                   error:
+#                     type: string
+#                     example: "User is not authenticated"

openapi/openapi.yaml

@@ -1,4 +1,4 @@
-openapi: 3.0.0
+openapi: 3.1.0
 info:
   version: 1.0.0
   title: Example.com
@@ -45,22 +45,13 @@ tags:
     description: s3
   - name: Test
     description: Test
-# servers:
-#   - url: https://{tenant}/api/v1
-#     variables:
-#       tenant:
-#         default: www
-#         description: Your tenant id
-#   - url: https://example.com/api/v1
+servers:
+  - url: https://example.com/api/v1
 paths:
-  /dataset:
-    $ref: paths/dataset_endpoints.yaml
-  /s3:
-    $ref: paths/s3_endpoints.yaml
-  /test:
-    $ref: paths/test_endpoints.yaml
-  /trainspace:
-    $ref: paths/trainspace_endpoints.yaml
+  /defaultDataset:
+    $ref: paths/defaultDataset.yaml
+  /getColumnsFromDatasetFile:
+    $ref: paths/getColumnsFromDatasetFile.yaml
 # components:
 #   securitySchemes:
 #     main_auth: