-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1963b7f
commit c6be302
Showing
12 changed files
with
233 additions
and
245 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" |
Oops, something went wrong.