Improvements to redocly format (#821)

* openapi root init * cont * cont * cont * cont * cont * cont * cont * contact info * license
DSGT-DLP · Jun 17, 2023 · 09e7076 · 09e7076
1 parent 7bfba5a
commit 09e7076
Show file tree

Hide file tree

Showing 13 changed files with 383 additions and 341 deletions.
diff --git a/openapi/dataset_endpoints.yaml b/openapi/dataset_endpoints.yaml
diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml
@@ -0,0 +1,58 @@
+openapi: 3.1.0
+info:
+  version: 1.0.0
+  title: Deep Learning Playground Backend API
+  contact:
+    email: dlp@datasciencegt.org
+    url: https://github.com/DSGT-DLP/Deep-Learning-Playground
+  license:
+    name: MIT
+    url: https://github.com/DSGT-DLP/Deep-Learning-Playground/blob/nextjs/LICENSE
+  description: >
+    Deep Learning Playground Backend API specifications
+
+tags:
+  - name: dataset
+    description: Everything about dataset
+  - name: s3
+    description: Everything about s3
+  - name: test
+    description: Test API endpoints
+  - name: trainspace
+    description: Everything about trainspace
+servers:
+  - url: https://example.com/api/v1
+paths:
+  /dataset/defaultDataset:
+    $ref: paths/dataset/defaultDataset.yaml
+  /dataset/getColumnsFromDatasetFile:
+    $ref: paths/dataset/getColumnsFromDatasetFile.yaml
+  /s3/getExecutionsFilesPresignedUrls:
+    $ref: paths/s3/getExecutionsFilesPresignedUrls.yaml
+  /s3/getSignedUploadUrl:
+    $ref: paths/s3/getSignedUploadUrl.yaml
+  /s3/getUserDatasetFilesData:
+    $ref: paths/s3/getUserDatasetFilesData.yaml
+  /test:
+    $ref: paths/test/none.yaml
+  /trainspace/create-trainspace:
+    $ref: paths/trainspace/create-trainspace.yaml
+  /trainspace/getTrainspaceData:
+    $ref: paths/trainspace/getTrainspaceData.yaml
+# components:
+#   securitySchemes:
+#     main_auth:
+#       type: oauth2
+#       flows:
+#         implicit:
+#           authorizationUrl: http://example.com/api/oauth/dialog
+#           scopes:
+#             read:users: read users info
+#             write:users: modify or remove users
+#     api_key:
+#       type: apiKey
+#       in: header
+#       name: api_key
+#     basic_auth:
+#       type: http
+#       scheme: basic
diff --git a/openapi/paths/dataset/defaultDataset.yaml b/openapi/paths/dataset/defaultDataset.yaml
@@ -0,0 +1,42 @@
+post:
+  summary: Default dataset
+  description: Endpoint to get user selected default dataset for training
+  tags:
+    - dataset
+  requestBody:
+    content:
+      application/json:
+        schema:
+          type: string
+          required:
+            - using_default_dataset
+          properties:
+            using_default_dataset:
+              type: string
+              description: dataset selected for training
+          example:
+            using_default_dataset: "IRIS"
+    required: true
+  responses:
+    "200":
+      description: Dataset selected successfully
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              columns:
+                type: array
+                example: [col1, col2, col3]
+    "400":
+      description: Dataset wasn't selected properly. 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"
diff --git a/openapi/paths/dataset/getColumnsFromDatasetFile.yaml b/openapi/paths/dataset/getColumnsFromDatasetFile.yaml
@@ -0,0 +1,52 @@
+post:
+  summary: Get columns from dataset file
+  description: "API Endpoint to retrieve columns from a user uploaded dataset file (eg: column names for a CSV file)"
+  tags:
+    - dataset
+  requestBody:
+    content:
+      application/json:
+        schema:
+          type: string
+          required:
+            - uid
+            - data_source
+            - name
+          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)"
+            name:
+              type: string
+              description: Name of dataset file
+          example:
+            uid: "1234"
+            data_source: "TABULAR"
+            name: "data.csv"
+    required: true
+  responses:
+    "200":
+      description: Columns Fetched Successfully
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              columns:
+                type: array
+                example: [col1, col2, col3]
+    "400":
+      description: Dataset columns weren't selected properly. 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"
diff --git a/openapi/paths/s3/getExecutionsFilesPresignedUrls.yaml b/openapi/paths/s3/getExecutionsFilesPresignedUrls.yaml
@@ -0,0 +1,41 @@
+post:
+  description: API Endpoint to use S3 Presigned URLs to retrieve result files from S3 given an execution id
+  tags:
+    - s3
+  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"
diff --git a/openapi/paths/s3/getSignedUploadUrl.yaml b/openapi/paths/s3/getSignedUploadUrl.yaml
@@ -0,0 +1,51 @@
+post:
+  description: Endpoint to upload files to S3
+  tags:
+    - 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"
diff --git a/openapi/paths/s3/getUserDatasetFilesData.yaml b/openapi/paths/s3/getUserDatasetFilesData.yaml
@@ -0,0 +1,42 @@
+post:
+  description: API Endpoint to retrieve all user dataset files uploaded in S3
+  tags:
+    - 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"