Hotfixes for Redocly root (#823)

* openapi root init * cont * cont * cont * cont * cont * cont * cont * contact info * license * hotfix * hotfix * added /api * added server url
DSGT-DLP · Jun 17, 2023 · 6f139ef · 6f139ef
1 parent 09e7076
commit 6f139ef
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 12 deletions.
diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml
@@ -21,23 +21,23 @@ tags:
   - name: trainspace
     description: Everything about trainspace
 servers:
-  - url: https://example.com/api/v1
+  - url: http://localhost:8000
 paths:
-  /dataset/defaultDataset:
+  /api/dataset/defaultDataset:
     $ref: paths/dataset/defaultDataset.yaml
-  /dataset/getColumnsFromDatasetFile:
+  /api/dataset/getColumnsFromDatasetFile:
     $ref: paths/dataset/getColumnsFromDatasetFile.yaml
-  /s3/getExecutionsFilesPresignedUrls:
+  /api/s3/getExecutionsFilesPresignedUrls:
     $ref: paths/s3/getExecutionsFilesPresignedUrls.yaml
-  /s3/getSignedUploadUrl:
+  /api/s3/getSignedUploadUrl:
     $ref: paths/s3/getSignedUploadUrl.yaml
-  /s3/getUserDatasetFilesData:
+  /api/s3/getUserDatasetFilesData:
     $ref: paths/s3/getUserDatasetFilesData.yaml
-  /test:
+  /api/test:
     $ref: paths/test/none.yaml
-  /trainspace/create-trainspace:
+  /api/trainspace/create-trainspace:
     $ref: paths/trainspace/create-trainspace.yaml
-  /trainspace/getTrainspaceData:
+  /api/trainspace/getTrainspaceData:
     $ref: paths/trainspace/getTrainspaceData.yaml
 # components:
 #   securitySchemes:

diff --git a/openapi/paths/dataset/defaultDataset.yaml b/openapi/paths/dataset/defaultDataset.yaml
@@ -7,7 +7,7 @@ post:
     content:
       application/json:
         schema:
-          type: string
+          type: object
           required:
             - using_default_dataset
           properties:

diff --git a/openapi/paths/dataset/getColumnsFromDatasetFile.yaml b/openapi/paths/dataset/getColumnsFromDatasetFile.yaml
@@ -7,7 +7,7 @@ post:
     content:
       application/json:
         schema:
-          type: string
+          type: object
           required:
             - uid
             - data_source

diff --git a/openapi/paths/s3/getExecutionsFilesPresignedUrls.yaml b/openapi/paths/s3/getExecutionsFilesPresignedUrls.yaml
@@ -1,4 +1,5 @@
 post:
+  summary: Get S3 Presigned URLs for result files
   description: API Endpoint to use S3 Presigned URLs to retrieve result files from S3 given an execution id
   tags:
     - s3

diff --git a/openapi/paths/s3/getSignedUploadUrl.yaml b/openapi/paths/s3/getSignedUploadUrl.yaml
@@ -1,4 +1,5 @@
 post:
+  summary: Get Signed Upload URL
   description: Endpoint to upload files to S3
   tags:
     - s3

diff --git a/openapi/paths/s3/getUserDatasetFilesData.yaml b/openapi/paths/s3/getUserDatasetFilesData.yaml
@@ -1,4 +1,5 @@
 post:
+  summary: Get User Dataset Files
   description: API Endpoint to retrieve all user dataset files uploaded in S3
   tags:
     - s3

diff --git a/openapi/paths/test/none.yaml b/openapi/paths/test/none.yaml
@@ -1,5 +1,6 @@
 get:
-  summary: A simple endpoint to test if our backend is alive
+  summary: Test Backend alive
+  description: A simple endpoint to test if our backend is alive
   tags:
     - test
   responses:

diff --git a/openapi/paths/trainspace/create-trainspace.yaml b/openapi/paths/trainspace/create-trainspace.yaml
@@ -1,4 +1,5 @@
 post:
+  summary: Create Trainspace
   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.
   tags:
     - trainspace

diff --git a/openapi/paths/trainspace/getTrainspaceData.yaml b/openapi/paths/trainspace/getTrainspaceData.yaml
@@ -1,4 +1,5 @@
 post:
+  summary: Get Trainspace Data
   description: API Endpoint to identify all trainspaces for a given user id.
   tags:
     - trainspace