Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

929 lab 1273 update openapi spec with auth and other updates to endpoints #934

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

929 lab 1273 update openapi spec with auth and other updates to endpoints #934

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b9593cc
user schema updated
acashmoney Mar 25, 2024
7c817ce
job schema updated
acashmoney Mar 25, 2024
ed20e32
datafile schema updated
acashmoney Mar 25, 2024
41e4388
user and job schemas refactored to exclude join table declarations in…
acashmoney Mar 25, 2024
f9936e7
Merge branch 'main' into 929-lab-1273-update-openapi-spec-with-auth-a…
acashmoney Mar 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
148 changes: 110 additions & 38 deletions gateway/lab-bio-api-spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -976,7 +976,31 @@
"type": "object",
"properties": {
"walletAddress": {
"type": "string"
"type": "string",
"format": "varchar(42)",
"description": "The user's wallet address, serving as the primary key."
},
"did": {
"type": "string",
"format": "varchar(255)",
"description": "The user's decentralized identifier."
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "The timestamp indicating when the user was created."
},
"apiKeys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/APIKey"
},
"description": "The list of API keys associated with the user."
},
"admin": {
"type": "boolean",
"default": false,
"description": "Indicates whether the user has admin privileges."
}
}
},
Expand Down Expand Up @@ -1029,35 +1053,29 @@
"type": "object",
"properties": {
"cid": {
"type": "string"
"type": "string",
"format": "varchar(255)",
"description": "The content identifier of the data file, serving as the primary key."
},
"walletAddress": {
"type": "string"
"type": "string",
"format": "varchar(42)",
"description": "The wallet address associated with the data file."
},
"filename": {
"type": "string"
},
"jobInputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Job"
}
},
"jobOutputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Job"
}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
"type": "string",
"format": "varchar(255)",
"description": "The name of the data file."
},
"timestamp": {
"type": "string",
"format": "date-time"
"format": "date-time",
"description": "The timestamp associated with the data file."
},
"public": {
"type": "boolean",
"default": false,
"description": "Indicates whether the data file is publicly accessible."
}
}
},
Expand All @@ -1084,41 +1102,95 @@
"Job": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The unique identifier of the job."
},
"bacalhauJobID": {
"type": "string"
"type": "string",
"format": "varchar(255)",
"description": "The ID of the associated Bacalhau job."
},
"state": {
"type": "string"
"type": "string",
"format": "varchar(255)",
"enum": [
"queued",
"running",
"failed",
"completed"
],
"default": "queued",
"description": "The current state of the job."
},
"error": {
"type": "string"
"type": "string",
"description": "The error message associated with the job, if any."
},
"walletAddress": {
"type": "string"
"type": "string",
"format": "varchar(255)",
"description": "The wallet address associated with the job."
},
"toolID": {
"type": "string"
"type": "string",
"format": "varchar(255)",
"description": "The ID of the tool used for the job."
},
"tool": {
"$ref": "#/components/schemas/Tool"
},
"flowID": {
"type": "string"
"type": "integer",
"format": "int64",
"description": "The ID of the flow associated with the job."
},
"flow": {
"$ref": "#/components/schemas/Flow"
},
"inputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataFile"
}
"type": "object",
"description": "The inputs for the job."
},
"outputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataFile"
}
"queue": {
"type": "string",
"format": "varchar(255)",
"enum": [
"cpu",
"gpu"
],
"description": "The queue type for the job."
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "The timestamp indicating when the job was created."
},
"startedAt": {
"type": "string",
"format": "date-time",
"description": "The timestamp indicating when the job started."
},
"completedAt": {
"type": "string",
"format": "date-time",
"description": "The timestamp indicating when the job was completed."
},
"annotations": {
"type": "string",
"format": "varchar(255)",
"description": "Additional annotations associated with the job."
},
"jobUUID": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of the job."
},
"public": {
"type": "boolean",
"default": false,
"description": "Indicates whether the job is publicly accessible."
}
}
},
Expand Down