Sébastien Han
fb3c9be1fd
refactor(api): rename "files" API to "artifacts"
...
The term "artifacts" better represents the purpose of this API, which
handles outputs generated by API executions, eventually stored objects
that can be of served by any storage interface (file, objects).
This aligns better with the industry convention of 'artifacts' (build
outputs, process results) rather than generic 'files'. 'files' would
be appropriate if the goal was to store and retrieve files purely.
Additionally, in our context, artifact is a better term since it will
handle:
* Data produced by SDG (Synthetic Data Generation) - as input
* Output of a trained model - as output
Signed-off-by: Sébastien Han <seb@redhat.com>
2025-05-12 21:52:14 +02:00
Vladimir Ivić
f7161611c6
feat: adding endpoints for files and uploads ( #1070 )
...
Summary:
Adds spec definitions for file uploads operations.
This API focuses around two high level operations:
* Initiating and managing upload session
* Accessing uploaded file information
Usage examples:
To start a file upload session:
```
curl -X POST https://localhost:8321/v1/files \
-d '{
"key": "image123.jpg',
"bucket": "images",
"mime_type": "image/jpg",
"size": 12345
}'
# Returns
{
“id”: <session_id>
“url”: “https://localhost:8321/v1/files/session :<session_id>”,
"offset": 0,
"size": 12345
}
```
To upload file content to an existing session
```
curl -i -X POST "https://localhost:8321/v1/files/session :<session_id> \
--data-binary @<path_to_local_file>
# Returns
{
"key": "image123.jpg",
"bucket": "images",
"mime_type": "image/jpg",
"bytes": 12345,
"created_at": 1737492240
}
# Implementing on server side (Flask example for simplicity):
@app.route('/uploads/{upload_id}', methods=['POST'])
def upload_content_to_session(upload_id):
try:
# Get the binary file data from the request body
file_data = request.data
# Save the file to disk
save_path = f"./uploads/{upload_id}"
with open(save_path, 'wb') as f:
f.write(file_data)
return {__uploaded_file_json__}, 200
except Exception as e:
return 500
```
To read information about an existing upload session
```
curl -i -X GET "https://localhost:8321/v1/files/session :<session_id>
# Returns
{
“id”: <session_id>
“url”: “https://localhost:8321/v1/files/session :<session_id>”,
"offset": 1024,
"size": 12345
}
```
To list buckets
```
GET /files
# Returns
{
"data": [
{"name": "bucket1"},
{"name": "bucket2"},
]
}
```
To list all files in a bucket
```
GET /files/{bucket}
# Returns
{
"data": [
{
"key": "shiba.jpg",
"bucket": "dogs",
"mime_type": "image/jpg",
"bytes": 82334,
"created_at": 1737492240,
},
{
"key": "persian_cat.jpg",
"mime_type": "image/jpg",
"bucket": "cats",
"bytes": 39924,
"created_at": 1727493440,
},
]
}
```
To get specific file info
```
GET /files/{bucket}/{key}
{
"key": "shiba.jpg",
"bucket": "dogs",
"mime_type": "image/jpg",
"bytes": 82334,
"created_at": 1737492240,
}
```
To delete specific file
```
DELETE /files/{bucket}/{key}
{
"key": "shiba.jpg",
"bucket": "dogs",
"mime_type": "image/jpg",
"bytes": 82334,
"created_at": 1737492240,
}
```
2025-02-20 13:09:00 -08:00
