Skip to content

Commit

Permalink
cont
Browse files Browse the repository at this point in the history
  • Loading branch information
farisdurrani committed Jun 17, 2023
1 parent 1963b7f commit c6be302
Show file tree
Hide file tree
Showing 12 changed files with 233 additions and 245 deletions.
137 changes: 0 additions & 137 deletions openapi/archive/s3_endpoints.yaml

This file was deleted.

20 changes: 0 additions & 20 deletions openapi/archive/test_endpoints.yaml

This file was deleted.

86 changes: 0 additions & 86 deletions openapi/archive/trainspace_endpoints.yaml

This file was deleted.

16 changes: 14 additions & 2 deletions openapi/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,21 @@ servers:
- url: https://example.com/api/v1
paths:
/dataset/defaultDataset:
$ref: paths/defaultDataset.yaml
$ref: paths/dataset/defaultDataset.yaml
/dataset/getColumnsFromDatasetFile:
$ref: paths/getColumnsFromDatasetFile.yaml
$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:
Expand Down
File renamed without changes.
39 changes: 39 additions & 0 deletions openapi/paths/s3/getExecutionsFilesPresignedUrls.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
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"
49 changes: 49 additions & 0 deletions openapi/paths/s3/getSignedUploadUrl.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
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"
Loading

0 comments on commit c6be302

Please sign in to comment.