FileUploadResponse
Response from file upload
Properties
| Property | Type | Required | Description |
|---|---|---|---|
status | string | ✅ Yes | Status: 'success' or 'error' |
files_uploaded | integer | ✅ Yes | Number of files successfully uploaded |
file_paths | array | ✅ Yes | Paths to uploaded files |
error | object | ❌ No | Error message if status is 'error' |
Example
{
"status": "example",
"files_uploaded": 0,
"file_paths": [],
"error": {}
}Used In
Code Examples
TypeScript
interface FileUploadResponse {
status: string;
files_uploaded: number;
file_paths: string[];
error?: any;
}
// Usage example
const data: FileUploadResponse = {
"status": "example",
"files_uploaded": 0,
"file_paths": [],
"error": {}
};Python
from data_layer.schemas import FileUploadResponse
# Create instance
data = FileUploadResponse(
# Add your field values here
)cURL
curl -X POST "https://altsportsleagues-backend-2qcdjegnaa-uc.a.run.app/api/endpoint" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{ "status": "example", "files_uploaded": 0, "file_paths": [], "error": {} }'Validation Rules
Required Fields: status, files_uploaded, file_paths
Additional Information
- Type: object
- Source: Generated from Pydantic models in
data_layer/schemas/ - Auto-validated: All fields are validated by FastAPI
This documentation is auto-generated from the OpenAPI specification.